Piloterr Aboutyou API
The Aboutyou API from Piloterr — 2 operation(s) for aboutyou.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-aboutyou-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Piloterr API Reference Aboutyou API
description: Complete API reference documentation.
version: 1.0.0
servers:
- url: https://api.piloterr.com
description: API Server
tags:
- name: Aboutyou
paths:
/v2/aboutyou/product:
get:
summary: About You Product
description: 'Read one About You product from a product URL or a keyword. A keyword opens the first search hit. Set region when the query does not already name the shop.
**Credit cost:** 2 credits per call'
operationId: get-aboutyou-product
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: Product URL or keyword. A keyword opens the first search result.
schema:
type: string
description: Product URL or keyword. A keyword opens the first search result.
- name: region
in: query
required: false
description: '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.'
schema:
type: string
description: '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.'
- name: return_page_source
in: query
required: false
description: Return the rendered HTML instead of JSON.
schema:
type: boolean
description: Return the rendered HTML instead of JSON.
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
id:
type: integer
url:
type: string
name:
type: string
brand:
type: string
color:
type: string
image:
type: string
price:
type: number
region:
type: string
currency:
type: string
in_stock:
type: boolean
price_display:
type: string
article_number:
type: string
original_price:
type: number
original_price_display:
type: string
examples:
PUMA Suede Bloom, France:
value:
id: 32191359
url: https://www.aboutyou.fr/p/puma/baskets-basses-suede-bloom-32191359
name: Baskets basses 'Suede Bloom'
brand: PUMA
color: rose
image: https://cdn.aboutstatic.com/file/images/f69d3161a57ca8a8aff626a5acc399bf.jpg?brightness=0.96&quality=75&trim=1
price: 69.9
region: fr
currency: EUR
in_stock: true
price_display: 69,90 €
article_number: PUMliff008000002
original_price: 89.9
original_price_display: 89,90 €
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Aboutyou
post:
summary: About You Product
description: 'Read one About You product from a product URL or a keyword. A keyword opens the first search hit. Set region when the query does not already name the shop.
**Credit cost:** 2 credits per call'
operationId: post-aboutyou-product
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: Product URL or keyword. A keyword opens the first search result.
region:
type: string
description: '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.'
return_page_source:
type: boolean
description: Return the rendered HTML instead of JSON.
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
id:
type: integer
url:
type: string
name:
type: string
brand:
type: string
color:
type: string
image:
type: string
price:
type: number
region:
type: string
currency:
type: string
in_stock:
type: boolean
price_display:
type: string
article_number:
type: string
original_price:
type: number
original_price_display:
type: string
examples:
PUMA Suede Bloom, France:
value:
id: 32191359
url: https://www.aboutyou.fr/p/puma/baskets-basses-suede-bloom-32191359
name: Baskets basses 'Suede Bloom'
brand: PUMA
color: rose
image: https://cdn.aboutstatic.com/file/images/f69d3161a57ca8a8aff626a5acc399bf.jpg?brightness=0.96&quality=75&trim=1
price: 69.9
region: fr
currency: EUR
in_stock: true
price_display: 69,90 €
article_number: PUMliff008000002
original_price: 89.9
original_price_display: 89,90 €
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Aboutyou
/v2/aboutyou/search:
get:
summary: About You Search
description: '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'
operationId: get-aboutyou-search
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: Keyword or About You search, category, or brand URL.
schema:
type: string
description: Keyword or About You search, category, or brand URL.
- name: region
in: query
required: false
description: '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.'
schema:
type: string
description: '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.'
- name: page
in: query
required: false
description: Only page 1 is available.
schema:
type: number
description: Only page 1 is available.
- name: return_page_source
in: query
required: false
description: Return the rendered HTML instead of JSON.
schema:
type: boolean
description: Return the rendered HTML instead of JSON.
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: integer
url:
type: string
name:
type: string
brand:
type: string
image:
type: string
price:
type: number
region:
type: string
currency:
type: string
price_display:
type: string
pagination:
type: object
properties:
next:
nullable: true
page:
type: integer
per_page:
type: integer
total_pages:
nullable: true
total_results:
nullable: true
examples:
Suede bloom, France:
value:
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
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Aboutyou
post:
summary: About You Search
description: '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'
operationId: post-aboutyou-search
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: Keyword or About You search, category, or brand URL.
region:
type: string
description: '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:
type: number
description: Only page 1 is available.
return_page_source:
type: boolean
description: Return the rendered HTML instead of JSON.
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: integer
url:
type: string
name:
type: string
brand:
type: string
image:
type: string
price:
type: number
region:
type: string
currency:
type: string
price_display:
type: string
pagination:
type: object
properties:
next:
nullable: true
page:
type: integer
per_page:
type: integer
total_pages:
nullable: true
total_results:
nullable: true
examples:
Suede bloom, France:
value:
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
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Aboutyou
components:
parameters:
fields:
name: fields
in: query
required: false
description: Comma-separated list of response fields to return, with dot notation for nested fields (e.g. `name,location.city`).
schema:
type: string
is_async:
name: is_async
in: query
required: false
description: 'Run the request as a background job: the API answers `202` with a `job_id` to poll on `GET /v1/jobs/{id}`.'
schema:
type: boolean
default: false
soft_fail:
name: soft_fail
in: query
required: false
description: Return HTTP 200 even when the request fails; the error is in the `error` field of the body.
schema:
type: boolean
default: false
schemas:
ErrorResponse:
type: object
required:
- error
properties:
error:
type: string
description: Human-readable error message.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: Your API key. Include it in the x-api-key header for every request.