ReefAPI

https://reefapi.com/docs
Admin
ReefAPI is a unified data platform providing over 400 production web scraping and extraction APIs...
Tokens:3,786,409
Snippets:19,383
Trust Score:5.2
Update:1 week ago
Show doc for...
Tokens:
Raw
### suggest

Source: https://reefapi.com/docs/yahoo-auctions

Get Yahoo! Auctions' own keyword suggestions for the start of a search term.

```APIDOC
## suggest

### Description
Get Yahoo! Auctions' own keyword suggestions for the start of a search term. Japan only; Taiwan returns MARKET_UNAVAILABLE.

### Method
GET

### Endpoint
/suggest

### Parameters
#### Query Parameters
- **query** (string) - Required - The start of a search term.
- **max_rotations** (integer) - Optional - Maximum number of suggestions.
- **country** (string) - Optional - Country code (e.g., JP, TW).

### Response
#### Success Response (200)
- **suggestions** (array) - List of suggested keywords.

#### Response Example
{
  "suggestions": ["camera", "camcorder", "camera bag"]
}
```

--------------------------------

### Call product/detail with Python

Source: https://reefapi.com/docs/1688

Python example using requests to POST to the product/detail endpoint. Requires the REEF_KEY environment variable and an offer_id.

```python
import requests

r = requests.post(
    "https://api.reefapi.com/1688/v1/product/detail",
    headers={"x-api-key": REEF_KEY},
    json={
  "offer_id": "864971848115"
},
)
print(r.json()["data"])
```

--------------------------------

### suggest

Source: https://reefapi.com/docs/trademe

Get Trade Me's own search suggestions for the start of a keyword, with suggested categories.

```APIDOC
## suggest

### Description
Get Trade Me's own search suggestions for the start of a keyword, with suggested categories.

### Parameters
- **query** (string) - The start of a keyword.
- **max_rotations** (integer) - Maximum number of rotations.

### Response
Returns search suggestions and suggested categories.
```

--------------------------------

### Call product/detail with JavaScript

Source: https://reefapi.com/docs/1688

JavaScript example using fetch to POST to the product/detail endpoint. Requires the REEF_KEY environment variable and an offer_id.

```javascript
const res = await fetch("https://api.reefapi.com/1688/v1/product/detail", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REEF_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
  "offer_id": "864971848115"
}),
});
const { ok, data, meta, error } = await res.json();
```

--------------------------------

### POST /yahoo-auctions/v1/suggest

Source: https://reefapi.com/docs/yahoo-auctions

Get Yahoo! Auctions' own keyword suggestions for the start of a search term. Japan only; Taiwan returns MARKET_UNAVAILABLE.

```APIDOC
## [POST] /yahoo-auctions/v1/suggest

### Description
Get Yahoo! Auctions' own keyword suggestions for the start of a search term. Japan only; Taiwan returns MARKET_UNAVAILABLE.

### Method
POST

### Endpoint
/yahoo-auctions/v1/suggest

### Parameters
#### Request Body
- **query** (string) - Required - The start of a keyword.
- **max_rotations** (integer) - Optional - Advanced: how many times to retry a difficult request (1-5). Default: 3.
- **country** (string) - Optional - Japan (jp) is the default. Taiwan (tw) supports search and product/detail only; page1-2, limit1-60 and listing_format are qualified. Other filters/actions remain Japan-only.

### Request Example
```json
{
  "query": "ポケモン"
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates success.
- **data** (object) - The suggestion data.
- **meta** (object) - Metadata including latency_ms, record_count, completeness_pct.
- **error** (null) - Error information, null on success.

#### Response Example
```json
{
  "ok": true,
  "data": { /* the result */ },
  "meta": {
    "latency_ms": 240,
    "record_count": 12,
    "completeness_pct": 100
  },
  "error": null
}
```
```

--------------------------------

### Call product/reviews with Python

Source: https://reefapi.com/docs/trustradius

Python example using requests library to POST to the product/reviews endpoint. Requires REEF_KEY environment variable.

```python
import requests

r = requests.post(
    "https://api.reefapi.com/trustradius/v1/product/reviews",
    headers={"x-api-key": REEF_KEY},
    json={
  "source": "trustradius",
  "product_slug": "slack",
  "fetch_all": true
},
)
print(r.json()["data"])
```

--------------------------------

### Call product/reviews with JavaScript

Source: https://reefapi.com/docs/trustradius

JavaScript example using fetch to POST to the product/reviews endpoint. Uses process.env.REEF_KEY for API key.

```javascript
const res = await fetch("https://api.reefapi.com/trustradius/v1/product/reviews", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REEF_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
  "source": "trustradius",
  "product_slug": "slack",
  "fetch_all": true
}),
});
const { ok, data, meta, error } = await res.json();
```

--------------------------------

### deals

Source: https://reefapi.com/docs/takealot

Get every promotion running on takealot right now, including promotion id, name, start and end, and a link.

```APIDOC
## deals

### Description
Every promotion running on takealot right now: promotion id, name, start and end, and a link. Use `deals/products` with a promotion id for the discounted products.

### Parameters
- **country** - Required - Country code.
- **max_rotations** - Optional - Maximum rotations.

### Response
Returns a list of promotions with fields as described.
```

--------------------------------

### suggest

Source: https://reefapi.com/docs/ricardo

Get ricardo's own keyword suggestions for the start of a search term, each with the category it points to when ricardo attaches one.

```APIDOC
## suggest

### Description
Get ricardo's own keyword suggestions for the start of a search term, each with the category it points to when ricardo attaches one.

### Parameters
- **query** (string) - The start of a search term.
- **language** (string) - Language for the response.
- **max_rotations** (number) - Maximum number of rotations.

### Response
Returns a list of keyword suggestions, each with an associated category if applicable.
```

--------------------------------

### POST /asos/v1/product

Source: https://reefapi.com/docs/asos

Fetch full product detail (sizes/stock/description/images) by product_id or product_url.

```APIDOC
## [POST] /asos/v1/product

### Description
Fetch full product detail (sizes/stock/description/images) by product_id or product_url.

### Method
POST

### Endpoint
/asos/v1/product

### Parameters
#### Query Parameters
- **product_id** (integer) - Optional - ASOS product id. (product needs product_id OR product_url.)
- **product_url** (string) - Optional - Full ASOS product URL (alternative to product_id).
- **store** (string) - Optional - ASOS market/store — sets default language, currency and ship-to country. Allowed values: COM, GB, US, DE, FR. Default: COM.

### Request Example
POST /asos/v1/product
Content-Type: application/json

{
  "product_id": 123456,
  "store": "COM"
}

### Response
#### Success Response (200)
- **product** (object) - Full product details including sizes, stock, description, and images.

#### Response Example
{
  "product": {}
}
```

--------------------------------

### Example request for /aliexpress/v1/deals (cURL)

Source: https://reefapi.com/docs/aliexpress

Shows a cURL POST request to the deals endpoint with an x-api-key header and a JSON body containing a query for 'wireless earbuds'. Use this to fetch discounted products.

```bash
curl -X POST https://api.reefapi.com/aliexpress/v1/deals \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"wireless earbuds"}'
```

--------------------------------

### POST /ikea/v1/categories

Source: https://reefapi.com/docs/ikea

Returns IKEA's category tree one level at a time, including product counts and child categories. Start at the root to get top-level departments.

```APIDOC
## POST /ikea/v1/categories

### Description
Returns IKEA's category tree one level at a time: a category with its product count and its child categories (key, name, product count). Start at the root for the top-level departments.

### Method
POST

### Endpoint
/ikea/v1/categories

### Parameters
#### Query Parameters
- **category_id** (string) - Optional - Category key to open. Default: the root ('products'), whose children are the top-level departments.
- **country** (string) - Optional - Which IKEA country store. Allowed values: ae, at, au, be, bh, ca, ch, cl, co, cz, de, dk, ee, eg, es, fi, fr, gb, hr, hu, ie, il, in, it, jo, jp, kr, kw, lt, lv, ma, mx, my, nl, no, nz, om, ph, pl, pt, qa, ro, rs, sa, se, sg, si, sk, th, us. Default: us.
- **language** (string) - Optional - Language of names, descriptions and filter labels. Allowed values: ar, ca, cs, da, de, en, es, et, eu, fi, fr, gl, he, hr, hu, it, ja, ko, lt, lv, ms, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, th. Default: the country's first language.
- **max_rotations** (integer) - Optional - Advanced: how many times to retry a difficult request. Allowed range: 1-6. Default: 3.

### Response
#### Success Response (200)
Returns the category tree with product counts and child categories.

```

--------------------------------

### Call product_match with JavaScript

Source: https://reefapi.com/docs/enrich-recall

JavaScript example using fetch to call product_match. The API key is read from process.env.REEF_KEY. Destructures the response into ok, data, meta, and error.

```javascript
const res = await fetch("https://api.reefapi.com/enrich-recall/v1/product_match", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REEF_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
  "gtin": "0860007279478"
}),
});
const { ok, data, meta, error } = await res.json();
```

--------------------------------

### cURL request to /che168/v1/cities

Source: https://reefapi.com/docs/che168

Example request to the cities endpoint using cURL. It posts a JSON body with a near_city_id to get neighbouring markets. Requires an API key in the x-api-key header.

```bash
curl -X POST https://api.reefapi.com/che168/v1/cities \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"near_city_id":110100}'
```

--------------------------------

### cURL request for product/detail

Source: https://reefapi.com/docs/offerup

Example cURL command to retrieve OfferUp listing details using the listing_id. Requires an API key in the x-api-key header.

```bash
curl -X POST https://api.reefapi.com/offerup/v1/product/detail \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"listing_id":"617edbe7-77f8-3284-a7da-d33032d49da0"}'
```

--------------------------------

### Quickstart: Convert currency with curl

Source: https://reefapi.com/docs

Example of a POST request to the currency conversion endpoint. Uses the x-api-key header and a JSON body with parameters. Requires a valid API key stored in the REEF_KEY environment variable.

```bash
curl -X POST https://api.reefapi.com/currency/v1/convert \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"from":"USD","to":"EUR","amount":1000}'

```

--------------------------------

### POST /asda/v1/catalog/product

Source: https://reefapi.com/docs/asda

Compatibility route for the same meaningful published CIN product detail.

```APIDOC
## [POST] /asda/v1/catalog/product

### Description
Compatibility route for the same meaningful published CIN product detail.

### Method
POST

### Endpoint
https://api.reefapi.com/asda/v1/catalog/product

### Parameters
#### Request Body
- **id** (string) - Required - The CIN (product identifier) to resolve.
- **zone** (string) - Optional - Zone identifier.
- **store_id** (string) - Optional - Store identifier.

### Request Example
{
  "id": "CIN123",
  "zone": "GB",
  "store_id": "store123"
}

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates success.
- **data** (object) - Product detail object.
- **meta** (object) - Metadata.
- **error** (object) - Error details if any.

#### Response Example
{
  "ok": true,
  "data": {},
  "meta": {},
  "error": null
}
```

--------------------------------

### POST /indeed/v1/company/reviews

Source: https://reefapi.com/docs/indeed

Get a company's employee reviews from Indeed, including review text, overall rating, sub-ratings, job title, location, and date. Pass the company name or Indeed /cmp slug; paginate with start.

```APIDOC
## POST /indeed/v1/company/reviews

### Description
Get a company's employee reviews from Indeed (review text, overall rating, the 5 sub-ratings — work/life balance, compensation, management, culture, job security — job title, location and date). Pass the company name or Indeed /cmp slug; paginate with `start`.

### Method
POST

### Endpoint
/indeed/v1/company/reviews

### Parameters
#### Request Body
- **company** (string) - Required - Company name or Indeed /cmp slug.
- **max_reviews** (integer) - Optional - How many reviews to return from this page (1–20). Default: 20.
- **start** (integer) - Optional - Pagination offset (0, 20, 40 …). Default: 0.
- **sort** (string) - Optional - How to order the reviews. Allowed values: relevance, helpfulness, rating_desc, rating_asc, date_desc. Default: relevance.

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates success.
- **data** (object) - The result data.
- **meta** (object) - Metadata including latency_ms, record_count, completeness_pct.
- **error** (null) - Error information, null if no error.

#### Response Example
{
  "ok": true,
  "data": { /* the result */ },
  "meta": {
    "latency_ms": 240,
    "record_count": 12,
    "completeness_pct": 100
  },
  "error": null
}
```

--------------------------------

### article/bids

Source: https://reefapi.com/docs/ricardo

Get the live bid ladder and full bid history for one article. Includes current highest bid, start price, next minimum bid, bid increment, bid count, time left, and every bid (amount, masked bidder nick, time, winning/autobid) in CHF.

```APIDOC
## article/bids

### Description
Get the live bid ladder and full bid history for one article. Includes current highest bid, start price, next minimum bid, bid increment, bid count, time left, and every bid (amount, masked bidder nick, time, winning/autobid) in CHF.

### Parameters
- **article_id** (string) - Identifier of the article.
- **language** (string) - Language for the response.
- **max_rotations** (number) - Maximum number of rotations (likely pagination or limit).

### Response
Returns bid ladder and history: current highest bid, start price, next minimum bid, bid increment, bid count, time left, and list of bids with amount, masked bidder nick, time, winning/autobid flags.
```

--------------------------------

### JavaScript: POST /alza/v1/search with fetch

Source: https://reefapi.com/docs/alza

JavaScript example using fetch to call the Alza search endpoint. Requires the REEF_KEY environment variable. Destructures ok, data, meta, and error from the JSON response.

```javascript
const res = await fetch("https://api.reefapi.com/alza/v1/search", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REEF_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
  "query": "iphone",
  "country": "cz"
}),
});
const { ok, data, meta, error } = await res.json();
```

--------------------------------

### POST /asda/v1/catalog/product

Source: https://reefapi.com/docs/asda

Compatibility route for the same meaningful published CIN product detail as the product/detail endpoint.

```APIDOC
## POST /asda/v1/catalog/product

### Description
Compatibility route for the same meaningful published CIN product detail.

### Method
POST

### Endpoint
/asda/v1/catalog/product

### Parameters
#### Query Parameters
- **id** (string) - Required - CIN returned by search; not an EAN or image identifier.
- **zone** (string) - Optional - Published price zone. Allowed: EN, SC, WA, NI. Default: EN.
- **store_id** (integer) - Optional - ASDA store identifier used for the published stock flag. Defaults to source store 4565; no delivery-slot guarantee.

### Request Example
```json
{
  "id": "CIN123"
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates success.
- **data** (object) - The product detail data.
- **meta** (object) - Metadata including latency_ms, record_count, completeness_pct.
- **error** (null) - Error information, null if no error.

#### Response Example
```json
{
  "ok": true,
  "data": { /* the product detail */ },
  "meta": {
    "latency_ms": 240,
    "record_count": 1,
    "completeness_pct": 100
  },
  "error": null
}
```
```

--------------------------------

### GET /suggest

Source: https://reefapi.com/docs/keh

Get search autocomplete suggestions from KEH's own autocomplete.

```APIDOC
## [GET] /suggest

### Description
KEH's own search autocomplete: turn a half-typed camera or lens name into the queries KEH actually resolves. One small request (under 5 KB measured), meant to be called before `search` so a keyword lands on real gear — which matters here, because KEH's search never answers empty and will relax a miss into a catalogue slice instead.

### Method
GET

### Endpoint
/suggest

### Parameters
#### Query Parameters
- **query** (string) - Required - Partial query.
- **count** (integer) - Optional - Number of suggestions.
- **include_pii** (boolean) - Optional - Include PII.

### Response
#### Success Response (200)
- **suggestions** (array) - List of suggested queries.

#### Response Example
{
  "suggestions": ["Canon EOS 5D", "Canon EOS 5D Mark II", "Canon EOS 5D Mark III"]
}
```

--------------------------------

### JavaScript: Search Kleinanzeigen with fetch

Source: https://reefapi.com/docs/kleinanzeigen

JavaScript example using fetch to POST a search query. Requires the REEF_KEY environment variable. Destructures ok, data, meta, and error from the JSON response.

```javascript
const res = await fetch("https://api.reefapi.com/kleinanzeigen/v1/search", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REEF_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
  "query": "iphone"
}),
});
const { ok, data, meta, error } = await res.json();
```

--------------------------------

### guides

Source: https://reefapi.com/docs/steam-games

Retrieves community guides for a game from Steam Workshop, with options for sorting and pagination.

```APIDOC
## guides

### Description
Retrieves community guides for a game from Steam Workshop, with options for sorting and pagination.

### Parameters
- **appid** (string) - Required - The Steam application ID.
- **sort** (string) - Optional - Sort order (e.g., top-rated, trending, most-recent).
- **page** (integer) - Optional - Page number.
- **limit** (integer) - Optional - Maximum number of guides.

### Response
Returns community guides with title, author, star rating, preview image, and URL.
```

--------------------------------

### Call OLX search with JavaScript fetch

Source: https://reefapi.com/docs/olx

JavaScript example using fetch to POST a search query. Requires the REEF_KEY environment variable. Destructures the response into ok, data, meta, and error.

```javascript
const res = await fetch("https://api.reefapi.com/olx/v1/search", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REEF_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({
  "query": "iphone",
  "country": "pl"
}),
});
const { ok, data, meta, error } = await res.json();
```

--------------------------------

### GET suggest

Source: https://reefapi.com/docs/trendyol

Get keyword suggestions for a query (ops; search-fallback if suggest API blocked).

```APIDOC
## GET suggest

### Description
Get keyword suggestions for a query (ops; search-fallback if suggest API blocked).

### Method
GET

### Endpoint
suggest

### Parameters
#### Query Parameters
- **query** (string) - Required - The query string.

### Response
#### Success Response (200)
- **suggestions** (array) - List of keyword suggestions.

#### Response Example
{
  "suggestions": []
}
```
Tokens:
Raw