Piloterr

About You Search

GET
/v2/aboutyou/search

Search an About You shop with a keyword or a search URL. Pick the country with region, or let a full link choose the shop. Cards include brand, price, and the product link.

Credit cost: 2 credits per call

Authorization

ApiKeyAuth
x-api-key<token>

Your API key. Include it in the x-api-key header for every request.

In: header

Query Parameters

query*string

Keyword or About You search, category, or brand URL.

region?string

Shop code. Default is fr. A full link in query picks the shop, and a conflicting region returns 400.

Examples:

fr
de
ch-fr

The full list is the Shops table in the readme.

page?number

Only page 1 is available.

return_page_source?boolean

Return the rendered HTML instead of JSON.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/aboutyou/search?query=string"
{  "results": [    {      "id": 24283626,      "url": "https://www.aboutyou.fr/p/puma/baskets-basses-suede-xl-24283626",      "name": "Baskets basses 'Suede XL'",      "brand": "PUMA",      "image": "https://cdn.aboutstatic.com/file/images/970952623a9504597b852a2f439e7c35.png?bg=F4F4F5&quality=75&trim=1",      "price": 99.95,      "region": "fr",      "currency": "EUR",      "price_display": "99,95 €"    }  ],  "pagination": {    "next": null,    "page": 1,    "per_page": 31,    "total_pages": null,    "total_results": null  }}
{  "error": "Bad Request"}
{  "error": "Invalid API Key"}
{  "error": "Payment required"}
{  "error": "Rate limit exceeded for the API key: quota monthly"}
{  "error": "Internal Error"}