Piloterr Ovoko API

The Ovoko API from Piloterr — 2 operation(s) for ovoko.

GitHub OpenAPI

Operations 4

GET /v2/ovoko/ad Ovoko Ad #
POST /v2/ovoko/ad Ovoko Ad #
POST /v2/ovoko/search Ovoko Search #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-ovoko-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

piloterr-com-ovoko-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Piloterr API Reference Ovoko API
  description: Complete API reference documentation.
  version: 1.0.0
servers:
- url: https://api.piloterr.com
  description: API Server
tags:
- name: Ovoko
paths:
  /v2/ovoko/ad:
    get:
      summary: Ovoko Ad
      description: 'Extract an Ovoko listing from a SKU URL: price, currency, images, seller, quality, vehicle make, part numbers, and warranty.


        **Credit cost:** 1 credit per call'
      operationId: get-ovoko-ad
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: "Full Ovoko listing URL. The last path segment must be a SKU slug (example: `qbb17557-95c827460c-porsche-macan-...`) or a known product prefix.\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Live product paths:**\n- France: `/les-pieces/`\n- Poland: `/czesci-samochodowe/`\n- Germany: `/gebrauchte-ersatzteile/`\n- Spain / Italy: `/parte/`\n- Finland: `/osat/`\n- Romania: `/piesa-uzata/`\n- Lithuania: `/autodalis/`\n- United Kingdom: `/en/used-part/`\n- Latvia: `/lv/auto-dalas/`\n- Russia: `/ru/zapchasti/`\n\n**Rejected:** search URLs, `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and catalog/offer paths.\n\n**Examples:**\n\n    https://ovoko.fr/les-pieces/lgn634714-1780a036-mitsubishi-asx-filtre-d-habitacle\n    https://ovoko.es/parte/ovp227641-6650473120-peugeot-407-filtro-de-combustible\n    https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni\n    https://rrr.lt/en/used-part/dzb40236-peugeot-607-fuel-filter\n    https://rrr.lt/ru/zapchasti/dzb40236-peugeot-607-filtr-topliva"
        schema:
          type: string
          description: "Full Ovoko listing URL. The last path segment must be a SKU slug (example: `qbb17557-95c827460c-porsche-macan-...`) or a known product prefix.\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Live product paths:**\n- France: `/les-pieces/`\n- Poland: `/czesci-samochodowe/`\n- Germany: `/gebrauchte-ersatzteile/`\n- Spain / Italy: `/parte/`\n- Finland: `/osat/`\n- Romania: `/piesa-uzata/`\n- Lithuania: `/autodalis/`\n- United Kingdom: `/en/used-part/`\n- Latvia: `/lv/auto-dalas/`\n- Russia: `/ru/zapchasti/`\n\n**Rejected:** search URLs, `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and catalog/offer paths.\n\n**Examples:**\n\n    https://ovoko.fr/les-pieces/lgn634714-1780a036-mitsubishi-asx-filtre-d-habitacle\n    https://ovoko.es/parte/ovp227641-6650473120-peugeot-407-filtro-de-combustible\n    https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni\n    https://rrr.lt/en/used-part/dzb40236-peugeot-607-fuel-filter\n    https://rrr.lt/ru/zapchasti/dzb40236-peugeot-607-filtr-topliva"
      - $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: string
                  rhd:
                    type: boolean
                  sku:
                    type: string
                  url:
                    type: string
                  sold:
                    type: boolean
                  price:
                    type: number
                  images:
                    type: array
                    items:
                      type: string
                  seller:
                    type: object
                    properties:
                      name:
                        type: string
                  status:
                    type: string
                  quality:
                    type: string
                  vehicle:
                    type: object
                    properties:
                      make:
                        type: string
                  category:
                    type: object
                    properties:
                      name:
                        type: string
                  currency:
                    type: string
                  discount:
                    type: integer
                  position:
                    type: string
                  warranty:
                    nullable: true
                  attributes:
                    type: array
                    items: {}
                  part_number:
                    type: string
                  part_numbers:
                    type: array
                    items:
                      type: string
                  display_labels:
                    type: array
                    items: {}
              examples:
                Lookup Audi A4 front bumper listing on Ovoko Poland:
                  value:
                    id: mth8663
                    rhd: false
                    sku: mth8663
                    url: https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni
                    sold: false
                    price: 1690.01
                    images:
                    - https://images.ovoko.com/bl/542x407/mth/0/0/0/0/0/8/6/6/3/c496a92f17dc1e839aebddf482037e83-audi_a4_s4_b9_front_bumper.jpg
                    seller:
                      name: Alex Martin
                    status: IN_STOCK
                    quality: USED
                    vehicle:
                      make: Audi
                    category:
                      name: Zderzak przedni
                    currency: PLN
                    discount: 75
                    position: FRONT
                    warranty: null
                    attributes: []
                    part_number: 8W0807437AB
                    part_numbers:
                    - 8W0807437AB
                    display_labels: []
        '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:
      - Ovoko
    post:
      summary: Ovoko Ad
      description: 'Extract an Ovoko listing from a SKU URL: price, currency, images, seller, quality, vehicle make, part numbers, and warranty.


        **Credit cost:** 1 credit per call'
      operationId: post-ovoko-ad
      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: "Full Ovoko listing URL. The last path segment must be a SKU slug (example: `qbb17557-95c827460c-porsche-macan-...`) or a known product prefix.\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Live product paths:**\n- France: `/les-pieces/`\n- Poland: `/czesci-samochodowe/`\n- Germany: `/gebrauchte-ersatzteile/`\n- Spain / Italy: `/parte/`\n- Finland: `/osat/`\n- Romania: `/piesa-uzata/`\n- Lithuania: `/autodalis/`\n- United Kingdom: `/en/used-part/`\n- Latvia: `/lv/auto-dalas/`\n- Russia: `/ru/zapchasti/`\n\n**Rejected:** search URLs, `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and catalog/offer paths.\n\n**Examples:**\n\n    https://ovoko.fr/les-pieces/lgn634714-1780a036-mitsubishi-asx-filtre-d-habitacle\n    https://ovoko.es/parte/ovp227641-6650473120-peugeot-407-filtro-de-combustible\n    https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni\n    https://rrr.lt/en/used-part/dzb40236-peugeot-607-fuel-filter\n    https://rrr.lt/ru/zapchasti/dzb40236-peugeot-607-filtr-topliva"
              required:
              - query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  rhd:
                    type: boolean
                  sku:
                    type: string
                  url:
                    type: string
                  sold:
                    type: boolean
                  price:
                    type: number
                  images:
                    type: array
                    items:
                      type: string
                  seller:
                    type: object
                    properties:
                      name:
                        type: string
                  status:
                    type: string
                  quality:
                    type: string
                  vehicle:
                    type: object
                    properties:
                      make:
                        type: string
                  category:
                    type: object
                    properties:
                      name:
                        type: string
                  currency:
                    type: string
                  discount:
                    type: integer
                  position:
                    type: string
                  warranty:
                    nullable: true
                  attributes:
                    type: array
                    items: {}
                  part_number:
                    type: string
                  part_numbers:
                    type: array
                    items:
                      type: string
                  display_labels:
                    type: array
                    items: {}
              examples:
                Lookup Audi A4 front bumper listing on Ovoko Poland:
                  value:
                    id: mth8663
                    rhd: false
                    sku: mth8663
                    url: https://ovoko.pl/czesci-samochodowe/mth8663-8w0807437ab-audi-a4-s4-b9-zderzak-przedni
                    sold: false
                    price: 1690.01
                    images:
                    - https://images.ovoko.com/bl/542x407/mth/0/0/0/0/0/8/6/6/3/c496a92f17dc1e839aebddf482037e83-audi_a4_s4_b9_front_bumper.jpg
                    seller:
                      name: Alex Martin
                    status: IN_STOCK
                    quality: USED
                    vehicle:
                      make: Audi
                    category:
                      name: Zderzak przedni
                    currency: PLN
                    discount: 75
                    position: FRONT
                    warranty: null
                    attributes: []
                    part_number: 8W0807437AB
                    part_numbers:
                    - 8W0807437AB
                    display_labels: []
        '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:
      - Ovoko
  /v2/ovoko/search:
    get:
      summary: Ovoko Search
      description: 'Search Ovoko used-parts listings from a search URL and retrieve title, price, OEM codes, seller, vehicle text, and pagination.


        **Credit cost:** 1 credit per call'
      operationId: get-ovoko-search
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: "Full Ovoko search URL. Only search pages are accepted (not category, catalog, or offer pages).\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Search paths:** `/chercher` (FR), `/szukaj` (PL), `/suche` (DE), `/buscar` (ES), `/ricerca` (IT), `/haku` (FI), `/cautare` (RO), `/paieska` (LT), `/en/search` (UK), `/lv/meklesana` (LV), `/ru/poisk` (RU).\n\n**Rejected:** `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and paths such as `/oferta/` or `/katalog-czesci/`.\n\n**Examples:**\n\n    https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1\n    https://ovoko.fr/chercher?q=filtre\n    https://ovoko.es/buscar?q=filtro\n    https://rrr.lt/en/search?q=filter\n    https://rrr.lt/ru/poisk?q=filtr\n\n**Notes:**\n- Append `&page=2` (or `?page=2`) to paginate. The response exposes `pagination.next`.\n- Every market returns the same listing keys. Use each result `url` with the Ovoko Ad endpoint.\n- Search `id` is the lowercase SKU and matches Ad `id` / `sku`."
        schema:
          type: string
          description: "Full Ovoko search URL. Only search pages are accepted (not category, catalog, or offer pages).\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Search paths:** `/chercher` (FR), `/szukaj` (PL), `/suche` (DE), `/buscar` (ES), `/ricerca` (IT), `/haku` (FI), `/cautare` (RO), `/paieska` (LT), `/en/search` (UK), `/lv/meklesana` (LV), `/ru/poisk` (RU).\n\n**Rejected:** `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and paths such as `/oferta/` or `/katalog-czesci/`.\n\n**Examples:**\n\n    https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1\n    https://ovoko.fr/chercher?q=filtre\n    https://ovoko.es/buscar?q=filtro\n    https://rrr.lt/en/search?q=filter\n    https://rrr.lt/ru/poisk?q=filtr\n\n**Notes:**\n- Append `&page=2` (or `?page=2`) to paginate. The response exposes `pagination.next`.\n- Every market returns the same listing keys. Use each result `url` with the Ovoko Ad endpoint.\n- Search `id` is the lowercase SKU and matches Ad `id` / `sku`."
      - $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: string
                        url:
                          type: string
                        image:
                          type: string
                        price:
                          type: number
                        title:
                          type: string
                        seller:
                          type: object
                          properties:
                            name:
                              type: string
                        vehicle:
                          type: string
                        currency:
                          type: string
                        part_number:
                          type: string
                        part_numbers:
                          type: array
                          items:
                            type: string
                  pagination:
                    type: object
                    properties:
                      next:
                        type: string
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_results:
                        type: integer
              examples:
                Search Porsche Macan tailgate seal on Ovoko Poland:
                  value:
                    results:
                    - id: qbb17557
                      url: https://ovoko.pl/czesci-samochodowe/qbb17557-95c827460c-porsche-macan-95c-uszczelka-tylnej-klapy-bagaznika
                      image: https://images.ovoko.com/tr/fill/1024x768/qbb/0/0/0/0/1/7/5/5/7/6e97a74672da438c268a980449538b78-porsche_macan__95c__seal_rubber__tailgate_.jpg
                      price: 200.01
                      title: Uszczelka tylnej klapy bagażnika
                      seller:
                        name: Example Motors
                      vehicle: Porsche Macan (95C)  2024  0cm3  0kW Manualna
                      currency: PLN
                      part_number: 95C827460C
                      part_numbers:
                      - 95C827460C
                    pagination:
                      next: https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1&page=2
                      page: 1
                      per_page: 15
                      total_pages: 667
                      total_results: 10000
        '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:
      - Ovoko
    post:
      summary: Ovoko Search
      description: 'Search Ovoko used-parts listings from a search URL and retrieve title, price, OEM codes, seller, vehicle text, and pagination.


        **Credit cost:** 1 credit per call'
      operationId: post-ovoko-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: "Full Ovoko search URL. Only search pages are accepted (not category, catalog, or offer pages).\n\n**Accepted hosts:** `ovoko.fr`, `ovoko.pl`, `ovoko.de`, `ovoko.es`, `ovoko.it`, `ovoko.fi`, `ovoko.ro`, `rrr.lt` (also `www.ovoko.fr`, `ovoko.lt` → `rrr.lt`, `ovoko.lv` → `rrr.lt/lv`).\n\n**Search paths:** `/chercher` (FR), `/szukaj` (PL), `/suche` (DE), `/buscar` (ES), `/ricerca` (IT), `/haku` (FI), `/cautare` (RO), `/paieska` (LT), `/en/search` (UK), `/lv/meklesana` (LV), `/ru/poisk` (RU).\n\n**Rejected:** `about.ovoko.com`, `ovoko.pt`, `ovoko.ee`, and paths such as `/oferta/` or `/katalog-czesci/`.\n\n**Examples:**\n\n    https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1\n    https://ovoko.fr/chercher?q=filtre\n    https://ovoko.es/buscar?q=filtro\n    https://rrr.lt/en/search?q=filter\n    https://rrr.lt/ru/poisk?q=filtr\n\n**Notes:**\n- Append `&page=2` (or `?page=2`) to paginate. The response exposes `pagination.next`.\n- Every market returns the same listing keys. Use each result `url` with the Ovoko Ad endpoint.\n- Search `id` is the lowercase SKU and matches Ad `id` / `sku`."
              required:
              - query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        url:
                          type: string
                        image:
                          type: string
                        price:
                          type: number
                        title:
                          type: string
                        seller:
                          type: object
                          properties:
                            name:
                              type: string
                        vehicle:
                          type: string
                        currency:
                          type: string
                        part_number:
                          type: string
                        part_numbers:
                          type: array
                          items:
                            type: string
                  pagination:
                    type: object
                    properties:
                      next:
                        type: string
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_results:
                        type: integer
              examples:
                Search Porsche Macan tailgate seal on Ovoko Poland:
                  value:
                    results:
                    - id: qbb17557
                      url: https://ovoko.pl/czesci-samochodowe/qbb17557-95c827460c-porsche-macan-95c-uszczelka-tylnej-klapy-bagaznika
                      image: https://images.ovoko.com/tr/fill/1024x768/qbb/0/0/0/0/1/7/5/5/7/6e97a74672da438c268a980449538b78-porsche_macan__95c__seal_rubber__tailgate_.jpg
                      price: 200.01
                      title: Uszczelka tylnej klapy bagażnika
                      seller:
                        name: Example Motors
                      vehicle: Porsche Macan (95C)  2024  0cm3  0kW Manualna
                      currency: PLN
                      part_number: 95C827460C
                      part_numbers:
                      - 95C827460C
                    pagination:
                      next: https://ovoko.pl/szukaj?q=Porsche+Macan+uszczelka+klapy+bagaznika&exact=1&page=2
                      page: 1
                      per_page: 15
                      total_pages: 667
                      total_results: 10000
        '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:
      - Ovoko
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.