aliexpress

Search AliExpress products

Returns AliExpress products matching a keyword, 10 per page by default (max 50). Each row has product id, title, sale price, shop name, and image. Pass the returned cursor back until has_more is false. Optional sort_by: price_low, price_high, most_sold, least_sold. Optional min_price and max_price are in the smallest currency unit (cents). A query that matches nothing comes back empty and is not billed.

get/aliexpress/search

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/aliexpress/search
  • Auth: API key in header x-api-key

Query parameters

querystring required

Search keywords, for example xiaomi or wireless earbuds.

pageinteger

Page number, starting at 1. Prefer the universal cursor parameter. Native upstream cursor param. Send the universal cursor instead: the API maps it to this name for you.

page_sizeinteger

Products per page, 1 to 50. Default 10.

sort_by'price_low' | 'price_high' | 'most_sold' | 'least_sold'

Result ordering: price_low, price_high, most_sold, or least_sold.

min_pricestring

Lowest price to include, in the smallest unit of the target currency (cents for USD).

max_pricestring

Highest price to include, in the smallest unit of the target currency (cents for USD).

category_idstring

AliExpress category id. Category ids come from GET /v1/aliexpress/categories.

delivery_daysinteger

Keep products that claim delivery within this many days.

countrystring

Ship-to country as a two-letter code. Default US. Changes displayed price and availability. A product that exists for US can return empty for another country.

currencystring

ISO 4217 currency for displayed prices. Default USD. Live-validated: USD GBP CAD EUR UAH MXN TRY RUB BRL AUD INR JPY IDR SEK KRW ILS THB CLP VND.

languagestring

Copy language as an ISO code. Default EN. Live-validated: EN RU PT ES FR ID IT TH JA AR VI TR DE HE KO NL PL MX CL IN.

cursorstring

Universal pagination cursor. Send pagination.next_cursor from the previous response back verbatim: the API maps it to this endpoint's native page (page style). You never construct, decode, or look up a cursor. Omit it for page 1.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "aliexpress",
  "endpoint": "/v1/aliexpress/search",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  },
  "pagination": {
    "next_cursor": "sc.eyJ2IjoyLCJjIjoiMiIsInAiOiJwYWdlIn0",
    "has_more": true,
    "page_size": 30,
    "stopped_at": "known_id"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.