> ## Documentation Index
> Fetch the complete documentation index at: https://docs.perceptlayer.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Perceptlayer is a web data API: one key for structured JSON from about 250 websites. Base URL https://api.perceptlayer.com.
> Send the key in the X-API-Key header. GET parameters go in the query string; POST parameters in a JSON body.
> A successful call costs the credits on its endpoint (X-Credits-Used); failed calls cost nothing. Errors are {"error": {"code", "message", "request_id"}}.
> AI agents can use every endpoint through the MCP server at https://api.perceptlayer.com/mcp (tools search_endpoints, get_endpoint, call_endpoint), with Authorization: Bearer <key>.
> Get a free key at https://perceptlayer.com/signup.

# Idealista: Map Search

> Map Search from Idealista. Costs 1 credit per successful call.

1 credit per successful call; failed calls are free. See the [Idealista API overview](https://perceptlayer.com/apis/idealista) for every Idealista endpoint.


## OpenAPI

````yaml /openapi.json get /v1/idealista/map-search
openapi: 3.1.0
info:
  title: Perceptlayer API
  version: 1.0.0
  description: >-
    One API key for structured web data. Each successful call costs the credits
    shown on its endpoint; failed calls are free.
servers:
  - url: https://api.perceptlayer.com
security:
  - ApiKeyAuth: []
tags:
  - name: 99acres
  - name: Agoda
  - name: Airbnb
  - name: AliExpress
  - name: Apartments.com
  - name: Apple App Store
  - name: Aramisauto
  - name: Arbeitsagentur Jobs
  - name: Argenprop
  - name: Autohero
  - name: AutoScout24
  - name: AutoTempest
  - name: AutoTrack.nl
  - name: Autotrader
  - name: AutoTrader.ca
  - name: AutoTrader UK
  - name: AutoUncle
  - name: Autovit
  - name: Baidu
  - name: Bandcamp
  - name: Bayut
  - name: Behance
  - name: Bien'ici
  - name: Bilbasen
  - name: Bilibili
  - name: Billiger.de
  - name: Bing
  - name: Blocket Bil
  - name: Bluesky
  - name: Boliga
  - name: Booking.com
  - name: Booli
  - name: Brave Search
  - name: Bring a Trailer
  - name: Capterra
  - name: CarDekho
  - name: CarGurus
  - name: CarMax
  - name: Cars & Bids
  - name: Cars.com
  - name: Cars24
  - name: Carsales
  - name: Carvana
  - name: Carwow
  - name: Casa.it
  - name: Centris
  - name: Coches.net
  - name: Copart
  - name: Craigslist
  - name: Crexi
  - name: Daft.ie
  - name: Dailymotion
  - name: DBA
  - name: Depop
  - name: DeviantArt
  - name: Dice
  - name: Domain Availability
  - name: Domain.com.au
  - name: Dribbble
  - name: Dubizzle
  - name: DuckDuckGo
  - name: eBay
  - name: Economy Car Rentals
  - name: Edmunds
  - name: Eventbrite
  - name: Expedia
  - name: Facebook
  - name: Facebook Ad Library
  - name: Fincaraiz
  - name: FINN
  - name: FINN Bil
  - name: Flickr
  - name: FlixBus
  - name: Fotocasa
  - name: Geizhals
  - name: Genius
  - name: GetYourGuide
  - name: GitHub
  - name: Glassdoor
  - name: Goodreads
  - name: Google Ads Transparency
  - name: Google Events
  - name: Google Finance
  - name: Google Flights
  - name: Google Forums
  - name: Google Hotels
  - name: Google Images
  - name: Google Jobs
  - name: Google Lens
  - name: Google Local
  - name: Google Local Services
  - name: Google Maps
  - name: Google News
  - name: Google Patents
  - name: Google Play
  - name: Google Related Questions
  - name: Google Scholar
  - name: Google Search
  - name: Google Shopping
  - name: Google Short Videos
  - name: Google Translate
  - name: Google Travel Explore
  - name: Google Trends
  - name: Google Videos
  - name: Gumtree
  - name: Habitaclia
  - name: Hacker News
  - name: Hemnet
  - name: heycar
  - name: HolidayCheck
  - name: Holidu
  - name: Homegate
  - name: HomeToGo
  - name: Hostelworld
  - name: HotPads
  - name: IAAI
  - name: Idealista
  - name: Idealo
  - name: Imgur
  - name: ImmobilienScout24
  - name: ImmobilienScout24 Austria
  - name: ImmoScout24 Switzerland
  - name: Immoweb
  - name: Immowelt
  - name: Imovirtual
  - name: Impressum Extraction
  - name: Indeed
  - name: InfoJobs
  - name: Inmuebles24
  - name: Instagram
  - name: Jameda
  - name: Kavak
  - name: Kayak Flights
  - name: Kayak
  - name: Kelley Blue Book
  - name: Kick
  - name: Kijiji
  - name: Kiwi.com
  - name: Kleinanzeigen
  - name: kununu
  - name: Kwai
  - name: La Centrale
  - name: Leboncoin Autos
  - name: Leboncoin Immo
  - name: Lemmy
  - name: Letterboxd
  - name: Link in Bio
  - name: LinkedIn
  - name: Linktree
  - name: LLM Answers
  - name: LoopNet
  - name: Madlan
  - name: MagicBricks
  - name: Marktplaats
  - name: Marktplaats Autos
  - name: Mastodon
  - name: Medium
  - name: Mercado Libre
  - name: Metrocuadrado
  - name: Milanuncios
  - name: Mixcloud
  - name: mobile.de
  - name: Motors.co.uk
  - name: MyAnimeList
  - name: Naukri
  - name: Naver
  - name: North Data
  - name: Odysee
  - name: OfferUp
  - name: Ohne-Makler
  - name: OLX Poland
  - name: Omio
  - name: OnTheMarket
  - name: Otodom
  - name: Otomoto
  - name: Patreon
  - name: Pinterest
  - name: Private Property
  - name: Product Hunt
  - name: Property Finder
  - name: realestate.com.au
  - name: Realtor.ca
  - name: Redfin
  - name: Reed
  - name: Rentalcars.com
  - name: Rentalia
  - name: Ricardo
  - name: Rightmove
  - name: Rumble
  - name: SEEK
  - name: SeLoger
  - name: Semrush
  - name: Similarweb
  - name: Skyscanner
  - name: Snapchat
  - name: SoundCloud
  - name: SpareRoom
  - name: Spotahome
  - name: Spotify
  - name: Sreality
  - name: Standvirtual
  - name: Startpage
  - name: Steam
  - name: StepStone
  - name: Subito
  - name: Subito Motori
  - name: Substack
  - name: SuperCasa
  - name: Telegram
  - name: Threads
  - name: TikTok
  - name: Trade Me Property
  - name: Trainline
  - name: Tripadvisor
  - name: Trivago
  - name: TrueCar
  - name: Trulia
  - name: Trusted Shops
  - name: Trustpilot
  - name: Truth Social
  - name: Tumblr
  - name: tutti.ch
  - name: Twitch
  - name: Viator
  - name: Vimeo
  - name: Vinted
  - name: VivaReal
  - name: VK
  - name: Vrbo
  - name: Wallapop
  - name: Walmart
  - name: Web Scraper
  - name: Weibo
  - name: Welcome to the Jungle
  - name: WG-Gesucht
  - name: willhaben
  - name: wlw
  - name: X (Twitter)
  - name: XING Jobs
  - name: Yad2
  - name: Yaencontre
  - name: Yahoo Search
  - name: Yelp
  - name: YouTube
  - name: Zillow
  - name: Zonaprop
  - name: Zoopla
  - name: Zumper
paths:
  /v1/idealista/map-search:
    get:
      tags:
        - Idealista
      summary: Map Search
      description: Map Search from Idealista. Costs 1 credit per successful call.
      operationId: idealista_map_search
      parameters:
        - name: country
          in: query
          required: true
          schema:
            type: string
            enum:
              - es
              - it
              - pt
              - fr
          example: es
        - name: operation
          in: query
          required: true
          schema:
            type: string
            enum:
              - sale
              - rent
          example: sale
        - name: property_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - homes
              - newDevelopments
              - bedrooms
              - offices
              - premises
              - transfers
              - buildings
              - storageRooms
              - garages
              - vacationRentals
              - luxury
              - lands
          example: homes
        - name: location_id
          in: query
          required: false
          schema:
            type: string
            maxLength: 80
          example: 0-EU-ES-28
        - name: center
          in: query
          required: false
          schema:
            type: string
            maxLength: 40
        - name: distance
          in: query
          required: false
          schema:
            type: integer
        - name: max_items
          in: query
          required: false
          schema:
            type: integer
        - name: num_page
          in: query
          required: false
          schema:
            type: integer
        - name: order
          in: query
          required: false
          schema:
            type: string
            maxLength: 40
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: quality
          in: query
          required: false
          schema:
            type: string
            enum:
              - high
              - low
        - name: gallery
          in: query
          required: false
          schema:
            type: boolean
        - name: locale
          in: query
          required: false
          schema:
            type: string
            maxLength: 8
        - name: microsite_short_name
          in: query
          required: false
          schema:
            type: string
            maxLength: 80
        - name: chalet
          in: query
          required: false
          schema:
            type: boolean
        - name: current_occupation_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - free
              - bareOwnership
              - tenanted
              - illegallyOccupied
              - viager
        - name: auction
          in: query
          required: false
          schema:
            type: string
            enum:
              - onlyAuctions
              - excludeAuctions
        - name: home_type
          in: query
          required: false
          schema:
            type: string
            maxLength: 40
        - name: bank_offer
          in: query
          required: false
          schema:
            type: string
            maxLength: 40
        - name: advertiser_type
          in: query
          required: false
          schema:
            type: string
            maxLength: 40
        - name: min_price
          in: query
          required: false
          schema:
            type: integer
        - name: max_price
          in: query
          required: false
          schema:
            type: integer
        - name: min_size
          in: query
          required: false
          schema:
            type: integer
        - name: max_size
          in: query
          required: false
          schema:
            type: integer
        - name: min_rooms
          in: query
          required: false
          schema:
            type: integer
        - name: max_rooms
          in: query
          required: false
          schema:
            type: integer
        - name: shape
          in: query
          required: false
          schema:
            type: string
        - name: mode
          in: query
          required: true
          schema:
            type: string
            enum:
              - listings
              - pins
          example: listings
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Credits-Used:
              $ref: '#/components/headers/CreditsUsed'
            X-Credits-Remaining:
              $ref: '#/components/headers/CreditsRemaining'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                type: object
                properties:
                  endpoint:
                    type: string
                  params:
                    type: object
                    properties:
                      country:
                        type: string
                      mode:
                        type: string
                      property_type:
                        type: string
                      operation:
                        type: string
                      location_id:
                        type: string
                  response:
                    type: object
                    properties:
                      success:
                        type: boolean
                      data:
                        type: object
                        properties:
                          elementList:
                            type: array
                            items:
                              type: object
                              properties:
                                propertyCode:
                                  type: string
                                thumbnail:
                                  type: string
                                externalReference:
                                  type: string
                                numPhotos:
                                  type: integer
                                price:
                                  type: integer
                                priceInfo:
                                  type: object
                                  properties:
                                    price:
                                      type: object
                                      properties:
                                        amount:
                                          type: integer
                                        currencySuffix:
                                          type: string
                                        priceDropInfo:
                                          type: string
                                propertyType:
                                  type: string
                                operation:
                                  type: string
                                size:
                                  type: integer
                                rooms:
                                  type: integer
                                bathrooms:
                                  type: integer
                                address:
                                  type: string
                                province:
                                  type: string
                                municipality:
                                  type: string
                                district:
                                  type: string
                                country:
                                  type: string
                                neighborhood:
                                  type: string
                                locationId:
                                  type: string
                                latitude:
                                  type: number
                                longitude:
                                  type: number
                                showAddress:
                                  type: boolean
                                url:
                                  type: string
                                description:
                                  type: string
                                hasVideo:
                                  type: boolean
                                status:
                                  type: string
                                newDevelopment:
                                  type: boolean
                                priceDropValue:
                                  type: integer
                                dropDate:
                                  type: integer
                                favourite:
                                  type: boolean
                                newProperty:
                                  type: boolean
                                multimedia:
                                  type: object
                                  properties:
                                    images:
                                      type: array
                                      items:
                                        type: string
                                    videos:
                                      type: array
                                      items:
                                        type: string
                                    virtual3DTours:
                                      type: array
                                      items:
                                        type: string
                                    homestagings:
                                      type: array
                                      items:
                                        type: string
                                contactInfo:
                                  type: object
                                  properties:
                                    commercialName:
                                      type: string
                                    phone1:
                                      type: object
                                      properties:
                                        phoneNumber:
                                          type: string
                                        formattedPhone:
                                          type: string
                                        prefix:
                                          type: string
                                        phoneNumberForMobileDialing:
                                          type: string
                                        nationalNumber:
                                          type: boolean
                                    contactName:
                                      type: string
                                    userType:
                                      type: string
                                    agencyLogo:
                                      type: string
                                    contactMethod:
                                      type: string
                                    micrositeShortName:
                                      type: string
                                    totalAds:
                                      type: integer
                                    needLoginForContact:
                                      type: boolean
                                    needLoginForPhone:
                                      type: boolean
                                parkingSpace:
                                  type: object
                                  properties:
                                    hasParkingSpace:
                                      type: boolean
                                    isParkingSpaceIncludedInPrice:
                                      type: boolean
                                priceDropPercentage:
                                  type: integer
                                priceByArea:
                                  type: integer
                                features:
                                  type: object
                                  properties:
                                    hasSwimmingPool:
                                      type: boolean
                                    hasTerrace:
                                      type: boolean
                                    hasAirConditioning:
                                      type: boolean
                                    hasBoxRoom:
                                      type: boolean
                                    hasGarden:
                                      type: boolean
                                detailedType:
                                  type: object
                                  properties:
                                    typology:
                                      type: string
                                suggestedTexts:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                hasPlan:
                                  type: boolean
                                has3DTour:
                                  type: boolean
                                has360:
                                  type: boolean
                                hasStaging:
                                  type: boolean
                                labels:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                      text:
                                        type: string
                                highlight:
                                  type: object
                                  properties:
                                    groupDescription:
                                      type: string
                                newDevelopmentHighlight:
                                  type: boolean
                                topPlus:
                                  type: boolean
                                topNewDevelopment:
                                  type: boolean
                                preferenceHighlight:
                                  type: boolean
                                topHighlight:
                                  type: boolean
                                urgentVisualHighlight:
                                  type: boolean
                                visualHighlight:
                                  type: boolean
                                floor:
                                  type: string
                                exterior:
                                  type: boolean
                                hasLift:
                                  type: boolean
                          total:
                            type: integer
                          totalPages:
                            type: integer
                          actualPage:
                            type: integer
                          itemsPerPage:
                            type: integer
                          numPaginations:
                            type: integer
                          summary:
                            type: array
                            items:
                              type: string
                          filter:
                            type: object
                            properties:
                              locationName:
                                type: string
                          alertName:
                            type: string
                          totalAppliedFilters:
                            type: integer
                          searchTitle:
                            type: string
                          paginable:
                            type: boolean
                          lowerRangePosition:
                            type: integer
                          upperRangePosition:
                            type: integer
                      meta:
                        type: object
                        properties:
                          duration_ms:
                            type: integer
                          endpoint_family:
                            type: string
                description: >-
                  The fields of a recorded response. Other responses can carry
                  more, or leave some out.
              example:
                endpoint: idealista.map-search
                params:
                  country: es
                  mode: listings
                  property_type: homes
                  operation: sale
                  location_id: 0-EU-ES-28
                response:
                  success: true
                  data:
                    elementList:
                      - propertyCode: '110108160'
                        thumbnail: >-
                          https://img4.idealista.com/s/v1/yLv6QcFaPGY-ndqtd3fIzjn3dwgl4inLwTKbMiVSd6Ml4khBqGDIaJvI4s5m5JvBdx6Ad9p6dwwLdwYIegv3PiUlPvfI9Zuoyw?Expires=1792875206&Signature=MEUCIG8Yn~IVnZmjCsOzAy5VCqhSdb7eLPAmA7Y7WiovVgbSAiEA9zpj4WyAOCxPzS178olkf0Dl~IVZ…
                        externalReference: CA217051
                        numPhotos: 33
                        price: 2200000
                        priceInfo:
                          price:
                            amount: 2200000
                            currencySuffix: €
                            priceDropInfo: …
                        propertyType: chalet
                        operation: sale
                        size: 480
                        rooms: 5
                        bathrooms: 5
                        address: >-
                          Chalet pareado en Paseo Club Deportivo, La Finca,
                          Pozuelo de Alarcón
                        province: Madrid
                        municipality: Pozuelo de Alarcón
                        district: Zona Prado de Somosaguas - La Finca
                        country: es
                        neighborhood: La Finca
                        locationId: 0-EU-ES-28-02-003-115-07-001
                        latitude: 40.4173893
                        longitude: -3.8060585
                        showAddress: false
                        url: https://www.idealista.com/inmueble/110108160/
                        description: >-
                          Descubre la exclusividad de este majestuoso chalet
                          pareado en una de las zonas más prestigiosas de
                          España: La Finca, en Pozuelo de Alarcón. Con 480 m² de
                          construcción sobre una parcela de 500 m², esta joya
                          arquitectónica se reparte en cuatr…
                        hasVideo: true
                        status: good
                        newDevelopment: false
                        priceDropValue: 200000
                        dropDate: 1792683875000
                        favourite: false
                        newProperty: false
                        multimedia:
                          images:
                            - …
                            - …
                            - …
                          videos:
                            - …
                          virtual3DTours:
                            - …
                          homestagings:
                            - …
                        contactInfo:
                          commercialName: Gilmar Pozuelo - Aravaca
                          phone1:
                            phoneNumber: '919385238'
                            formattedPhone: 919 38 52 38
                            prefix: '34'
                            phoneNumberForMobileDialing: '+34919385238'
                            nationalNumber: true
                          contactName: CA Gilmar
                          userType: professional
                          agencyLogo: https://st3.idealista.com/fb/d8/2a/gilmarpozuelo.gif
                          contactMethod: all
                          micrositeShortName: gilmarpozuelo
                          totalAds: 0
                          needLoginForContact: false
                          needLoginForPhone: false
                        parkingSpace:
                          hasParkingSpace: true
                          isParkingSpaceIncludedInPrice: true
                        priceDropPercentage: 8
                        priceByArea: 4583
                        features:
                          hasSwimmingPool: true
                          hasTerrace: true
                          hasAirConditioning: true
                          hasBoxRoom: true
                          hasGarden: true
                        detailedType:
                          typology: chalet
                          subTypology: semidetachedHouse
                        suggestedTexts:
                          title: >-
                            Chalet pareado en Paseo Club Deportivo, La Finca,
                            Pozuelo de Alarcón
                        hasPlan: true
                        has3DTour: true
                        has360: false
                        hasStaging: true
                        labels:
                          - name: luxuryType
                            text: Lujo
                        highlight:
                          groupDescription: Top+
                        newDevelopmentHighlight: false
                        topPlus: true
                        topNewDevelopment: false
                        preferenceHighlight: false
                        topHighlight: false
                        urgentVisualHighlight: false
                        visualHighlight: false
                      - propertyCode: '111379612'
                        thumbnail: >-
                          https://img4.idealista.com/s/v1/yLv6QcFaPGY-ndqtd3fIzjn3dwgl4inLwTKbMiVSd6Ml4khBqGDIaJvI4s5m5JvBd7UMd_ejdz4GdwYI9wijeggMDAbI9Zuoyw?Expires=1792875206&Signature=MEYCIQCpO0oeX3IZ1sRYhrxpmZBUa5dSroICWzWkfKGuLLSM5QIhAKAKrBJCwVB38NhyUWmbxvyXdGWM…
                        externalReference: W-049Q33
                        numPhotos: 29
                        floor: '1'
                        price: 990000
                        priceInfo:
                          price:
                            amount: 990000
                            currencySuffix: €
                            priceDropInfo: …
                        propertyType: flat
                        operation: sale
                        size: 133
                        exterior: true
                        rooms: 3
                        bathrooms: 2
                        address: >-
                          Piso en Calle de Santa Brígida, Chueca-Justicia,
                          Madrid
                        province: Madrid
                        municipality: Madrid
                        district: Centro
                        country: es
                        neighborhood: Chueca-Justicia
                        locationId: 0-EU-ES-28-07-001-079-01-004
                        latitude: 40.4252684
                        longitude: -3.7008748
                        showAddress: false
                        url: https://www.idealista.com/inmueble/111379612/
                        description: >-
                          Oportunidad de inversión con 3 balcones en Justicia
                          Engel & Völkers, inmobiliaria de lujo, tiene el placer
                          de comercializar esta exclusiva propiedad exterior de
                          132 m2 aprox según Registro, en el vibrante corazón
                          del barrio de Justicia, la …
                        hasVideo: true
                        status: good
                        newDevelopment: false
                        priceDropValue: 110000
                        dropDate: 1792490310000
                        favourite: false
                        newProperty: false
                        multimedia:
                          images:
                            - …
                            - …
                            - …
                          videos:
                            - …
                          virtual3DTours:
                            - …
                          homestagings:
                            - …
                            - …
                        contactInfo:
                          commercialName: Engel & Völkers Madrid
                          phone1:
                            phoneNumber: '919386811'
                            formattedPhone: 919 38 68 11
                            prefix: '34'
                            phoneNumberForMobileDialing: '+34919386811'
                            nationalNumber: true
                          contactName: Engel & Völkers Madrid MMC
                          userType: professional
                          agencyLogo: >-
                            https://st3.idealista.com/56/f1/09/engel-volkers-madrid.gif
                          contactMethod: all
                          micrositeShortName: engel-volkers-madrid
                          totalAds: 0
                          needLoginForContact: false
                          needLoginForPhone: false
                        hasLift: false
                        priceDropPercentage: 10
                        priceByArea: 7444
                        features:
                          hasSwimmingPool: false
                          hasTerrace: false
                          hasAirConditioning: true
                          hasBoxRoom: false
                          hasGarden: false
                        detailedType:
                          typology: flat
                        suggestedTexts:
                          title: >-
                            Piso en Calle de Santa Brígida, Chueca-Justicia,
                            Madrid
                        hasPlan: true
                        has3DTour: true
                        has360: false
                        hasStaging: true
                        highlight:
                          groupDescription: Top+
                        newDevelopmentHighlight: false
                        topPlus: true
                        topNewDevelopment: false
                        preferenceHighlight: false
                        topHighlight: false
                        urgentVisualHighlight: false
                        visualHighlight: false
                    total: 33943
                    totalPages: 16972
                    actualPage: 1
                    itemsPerPage: 2
                    numPaginations: 0
                    summary:
                      - Comprar casas y pisos en Madrid provincia
                      - Todos los precios
                      - Todos los tamaños
                    filter:
                      locationName: Madrid
                    alertName: Viviendas en Madrid
                    totalAppliedFilters: 0
                    searchTitle: Madrid provincia
                    paginable: true
                    lowerRangePosition: 0
                    upperRangePosition: 2
                  meta:
                    duration_ms: 764
                    endpoint_family: map_search
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '410':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
        '504':
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: Unique ID for this request; quote it in support requests.
      schema:
        type: string
    CreditsUsed:
      description: Credits charged for this call (0 when it failed).
      schema:
        type: integer
    CreditsRemaining:
      description: Your balance after this call.
      schema:
        type: integer
    RateLimitLimit:
      description: >-
        Requests a minute your account may make: its rate in requests per second
        times 60.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current minute, shared by every key on the account.
      schema:
        type: integer
    RateLimitReset:
      description: Seconds until the current minute's count starts over.
      schema:
        type: integer
    RateLimitPolicy:
      description: The limit and its window in seconds, for example "300;w=60".
      schema:
        type: string
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.