Apinoa Docs

Image Search

Find AliExpress products from a photo.

View raw .mdx
POST /v1/aliexpress/image-search

POST only, with a JSON body.

Request

curl -X POST "https://gateway.apinoa.com/v1/aliexpress/image-search" \
  -H "x-api-key: $APINOA_API_KEY" \
  -H "content-type: application/json" \
  -d "{\"image\": {\"contentType\": \"image/jpeg\", \"data\": \"$(base64 < photo.jpg | tr -d '\n')\"}}"

Parameters

ParameterTypeRequiredNotes
imageobjectyes{contentType, data} with base64-encoded image bytes.
currencystringPresentment currency.
languagestringPresentment language.
regionstringBuyer country (ISO 3166-1 alpha-2).

The same parameters, and every response type, are in the OpenAPI document.

Response

Returns SearchResult in data. A real response, shortened: arrays keep their first entries and long text is cut.

{
  "data": {
    "marketplace": "aliexpress",
    "page": {
      "index": 1,
      "size": 20
    },
    "items": [
      {
        "marketplace": "aliexpress",
        "id": "1005008042636168",
        "url": "https://www.aliexpress.com/item/1005008042636168.html?skuId=12000043389210060&pdp_ext_f=%7B%22sku_id%22%3A%221200004338…",
        "title": "3 Pairs Men Women Merino Wool Crew Socks Thickened Thermal and Warm Socks for Winter Work Outdoor Hiking Running Sports…",
        "price": {
          "currency": "USD",
          "amount": 15.31
        },
        "salesCount": 213,
        "badges": [],
        "promotions": [],
        "attributes": [],
        "imageUrl": "https://ae-pic-a1.aliexpress-media.com/kf/S6b7ec42cccf64a90805d96191a8086ffn.jpg"
      }
    ]
  },
  "requestId": "a6a7fcf8e5254b3c9545228c82281021",
  "success": true
}

Errors

StatusCodeMeaning
400INVALID_PARAMSA parameter is missing, unknown or out of range. The message names it.
401UNAUTHORIZEDThe x-api-key header is missing, or the key is revoked or unknown.
402INSUFFICIENT_BALANCEThe balance does not cover this call. Top up in the dashboard.
503TOKEN_EXPIREDAliExpress is temporarily unavailable. Retry later.

Every code is listed in Errors. Failed calls are not billed.

Pricing

Price $0.001 per call. List price; the rate steps down above 1,000 calls a day.

Notes

  • POST only, with the image as base64 in a JSON body.
  • The picture is the only input. There is no query, and no paging: it always returns the first page.

On this page