openapi: 3.1.0
info:
  title: Monocrawl
  version: 0.1.0
  description: "One key, one envelope, one credit meter across social, search, commerce and web data. Every data endpoint is `GET` with query-string parameters; the single exception is `POST /v1/batch`. Two optional parameters work on every cacheable endpoint: `fresh=1` (or a `Cache-Control: no-cache` header) fetches a genuinely fresh answer at the endpoint price, up to 30 times a minute per key; `max_age=<seconds>` (minimum 30) accepts a cached answer only if it is at most that old. A cached answer says `\"cached\": true`, sends `x-cache: HIT` and costs 0 credits. Responses always carry `credits_used`, `credits_remaining` and `request_id`. Guides live at https://www.monocrawl.com/docs. This document projects the endpoint registry; x-production-available is a structural eligibility check, not a live service guarantee. Payload fields and continuation contracts vary by endpoint; optional model-derived output is labelled where supported."
  contact:
    name: Monocrawl support
    url: https://www.monocrawl.com/contact
  termsOfService: https://www.monocrawl.com/legal/terms-and-conditions
servers:
  - url: https://www.monocrawl.com
security:
  - ApiKeyHeader: []
tags:
  - name: Airbnb
  - name: AliExpress
  - name: Amazon
  - name: App Store
  - name: Apple Music
  - name: Bluesky
  - name: Booking.com
  - name: Cohort Queries
  - name: Cohorts
  - name: Companies House
  - name: Content Analysis
  - name: Credits
  - name: eBay
  - name: Etsy
  - name: Facebook
  - name: G2
  - name: GitHub
  - name: Google Ads Transparency
  - name: Google Finance
  - name: Google News
  - name: Google Places
  - name: Google Play
  - name: Google Quick Search
  - name: Google Search
  - name: Google Shopping
  - name: Google Trends
  - name: Gumtree
  - name: H&M
  - name: Hacker News
  - name: Home Depot
  - name: Instagram
  - name: Job boards
  - name: Kick
  - name: Klarna
  - name: Kohl's
  - name: Komi
  - name: Kwai
  - name: LinkedIn
  - name: LinkedIn Ads
  - name: LinkMe
  - name: Linktree
  - name: lnk.bio
  - name: Markets
  - name: Meta Ad Library
  - name: Monitors
  - name: Mosaic
  - name: On-Page
  - name: Panorama
  - name: Pillar
  - name: Pinterest
  - name: Polymarket
  - name: Quora
  - name: Reddit
  - name: Research
  - name: Rightmove
  - name: Rumble
  - name: Sephora
  - name: Snapchat
  - name: SoundCloud
  - name: Spotify
  - name: Status
  - name: Target
  - name: Telegram
  - name: Threads
  - name: TikTok
  - name: TikTok Ads
  - name: TikTok Shop
  - name: TripAdvisor
  - name: Trustpilot
  - name: Truth Social
  - name: Twitch
  - name: Utility
  - name: Walmart
  - name: Wayfair
  - name: Web Scraping
  - name: X
  - name: Yelp
  - name: YouTube
  - name: Zoopla
  - name: Batch
    description: Run several requests in one HTTP call.
paths:
  /v1/airbnb/experience:
    get:
      operationId: airbnb_experience
      tags:
        - Airbnb
      summary: Airbnb experience
      description: "One experience's page: title, meeting point and position, duration and details, rating and reviews, what you'll do, what is included, highlights, the from-price, group size, the dates offered with spaces left, guest requirements, what to bring, the cancellation policy, the host and the photos. Sections the page carried beyond this are named in _warnings. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "358359"
          description: The experience number (or pass url, the experience's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The experience's page URL instead of an id
        - name: from_date
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: First date, YYYY-MM-DD, for the dates offered
        - name: to_date
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Last date, YYYY-MM-DD
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Adults, up to 16
        - name: children
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children, up to 15
        - name: infants
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Infants, up to 5
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/experience-reviews:
    get:
      operationId: airbnb_experience_reviews
      tags:
        - Airbnb
      summary: Airbnb experience reviews
      description: "Guest reviews of one experience: text, rating, date, language, the reviewer and the host, and the host's reply. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3675199"
          description: The experience number (or pass url, the experience's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The experience's page URL instead of an id
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews per page, 1 to 50
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only reviews mentioning this
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/locations:
    get:
      operationId: airbnb_locations
      tags:
        - Airbnb
      summary: Airbnb place lookup
      description: The places the site knows for a name, each with the place id the searches take, its Google place id, country and bounds. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Lisbon
          description: A city, area or address
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "5"
          description: Suggestions, 1 to 20
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/search-experiences:
    get:
      operationId: airbnb_search_experiences
      tags:
        - Airbnb
      summary: Airbnb experience search
      description: "Experiences in a place: title, duration, category, rating and review count, position, the from-price as the site shows it, photo and the host. Pages by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Lisbon
          description: A city or area; resolved to a place once and remembered (or pass place_id)
        - name: place_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A place id from airbnb/locations
        - name: from_date
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: First date, YYYY-MM-DD
        - name: to_date
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Last date, YYYY-MM-DD
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Adults, up to 16
        - name: children
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children, up to 15
        - name: infants
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Infants, up to 5
        - name: activity_type
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's activity-type filter
        - name: language_offered
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's language-offered filter
        - name: time_of_day
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's time-of-day filter
        - name: accessibility
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's accessibility-feature filter
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price per person in the currency
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price per person in the currency
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Results per page, 1 to 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The cursor from the previous page
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/search-stays:
    get:
      operationId: airbnb_search_stays
      tags:
        - Airbnb
      summary: Airbnb stay search
      description: "Stays in a place for a trip: name, city, room type, rating and review count, position, the nightly price and the trip total as the site shows them, photos, instant booking and the host with their rating and years hosting. Pages by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Lisbon
          description: A city, area or address; resolved to a place once and remembered (or pass place_id)
        - name: place_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A place id from airbnb/locations
        - name: checkin
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-10"
          description: Check-in date, YYYY-MM-DD (with checkout)
        - name: checkout
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-14"
          description: Check-out date, YYYY-MM-DD (with checkin)
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults, up to 16
        - name: children
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children, up to 15
        - name: infants
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Infants, up to 5
        - name: pets
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Pets, up to 5
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price per night in the currency
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price per night in the currency
        - name: type_of_place
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's type-of-place filter
        - name: property_type
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's property-type filter
        - name: bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum bedrooms
        - name: beds
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum beds
        - name: bathrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum bathrooms
        - name: amenities
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's amenity ids, separated by commas
        - name: booking_options
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's booking-option filters
        - name: host_language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's host-language filter
        - name: top_tier
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's top-tier-stays filter
        - name: total_price
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Show the trip total instead of the nightly price
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "16"
          description: Results per page, 1 to 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The cursor from the previous page
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/stay:
    get:
      operationId: airbnb_stay
      tags:
        - Airbnb
      summary: Airbnb stay
      description: "One stay's page: name and headline, property type, location and position, capacity, rating and reviews, description, highlights, amenities by group, house rules, safety, cancellation policies, instant booking, the host with their tags and response figures, and the photos. Sections the page carried beyond this are named in _warnings. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "6332745"
          description: The listing number (or pass url, the stay's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The stay's page URL instead of an id
        - name: checkin
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Check-in date, YYYY-MM-DD (with checkout), for dated pricing
        - name: checkout
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Check-out date, YYYY-MM-DD (with checkin)
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults, up to 16
        - name: children
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children, up to 15
        - name: infants
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Infants, up to 5
        - name: pets
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Pets, up to 5
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/stay-availability:
    get:
      operationId: airbnb_stay_availability
      tags:
        - Airbnb
      summary: Airbnb stay calendar
      description: "One stay's calendar month by month: each day's availability, whether check-in and check-out are allowed, the minimum and maximum nights and the price where the site shows one. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "6332745"
          description: The listing number (or pass url, the stay's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The stay's page URL instead of an id
        - name: month
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: First month, 1 to 12
        - name: year
          in: query
          required: false
          schema:
            type: string
          example: "2026"
          description: First year
        - name: months
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: How many months, 1 to 12
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/stay-price:
    get:
      operationId: airbnb_stay_price
      tags:
        - Airbnb
      summary: Airbnb stay price
      description: "What one stay costs for a trip, as the site shows it: the nightly price with any discount, the breakdown (nights, cleaning, service fee, taxes), availability, instant booking, pets and the cancellation policy. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "6332745"
          description: The listing number (or pass url, the stay's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The stay's page URL instead of an id
        - name: checkin
          in: query
          required: true
          schema:
            type: string
          example: "2026-10-10"
          description: Check-in date, YYYY-MM-DD
        - name: checkout
          in: query
          required: true
          schema:
            type: string
          example: "2026-10-12"
          description: Check-out date, YYYY-MM-DD
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults, up to 16
        - name: children
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children, up to 15
        - name: infants
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Infants, up to 5
        - name: pets
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Pets, up to 5
        - name: total_price
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Show the trip total instead of the nightly price
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/stay-rating:
    get:
      operationId: airbnb_stay_rating
      tags:
        - Airbnb
      summary: Airbnb stay rating
      description: One stay's overall rating and review count with the category ratings (cleanliness, accuracy, communication, location, check-in, value). Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "6332745"
          description: The listing number (or pass url, the stay's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The stay's page URL instead of an id
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Three-letter currency code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/airbnb/stay-reviews:
    get:
      operationId: airbnb_stay_reviews
      tags:
        - Airbnb
      summary: Airbnb stay reviews
      description: "Guest reviews of one stay: text, rating, date, language, highlight, the reviewer and the host, the host's reply and photos. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "6332745"
          description: The listing number (or pass url, the stay's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The stay's page URL instead of an id
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews per page, 1 to 50
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's review sort (BEST_QUALITY, MOST_RECENT…)
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only reviews mentioning this
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/categories:
    get:
      operationId: aliexpress_categories
      tags:
        - AliExpress
      summary: AliExpress categories
      description: AliExpress's top-level categories with their children and ids for aliexpress/search. Costs 1 credit per successful live response.
      parameters:
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/description:
    get:
      operationId: aliexpress_description
      tags:
        - AliExpress
      summary: AliExpress product description
      description: The full description text and images of an AliExpress product, with its property list. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1005005244562338"
          description: AliExpress item id
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/product:
    get:
      operationId: aliexpress_product
      tags:
        - AliExpress
      summary: AliExpress product
      description: "One AliExpress product: title, price range and promotion, rating, sales, images and video, properties, description, variants and options, shipping options and the seller. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1005005244562338"
          description: AliExpress item id (the number in its URL), or the URL
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Storefront country
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/promos:
    get:
      operationId: aliexpress_promos
      tags:
        - AliExpress
      summary: AliExpress promotions
      description: The featured AliExpress promotions currently running, with the number of products in each; a name goes to aliexpress/search-promo. Costs 1 credit per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/reviews:
    get:
      operationId: aliexpress_reviews
      tags:
        - AliExpress
      summary: AliExpress product reviews
      description: Reviews of an AliExpress product, twenty per page, with the rating distribution and buyer country. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3256809769628322"
          description: AliExpress item id
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (20 per page)
        - name: filter
          in: query
          required: false
          schema:
            type: string
          example: allReviews
          description: A filter value from the response's filters list
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A sort value from the response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/search:
    get:
      operationId: aliexpress_search
      tags:
        - AliExpress
      summary: AliExpress product search
      description: Products matching a keyword, twenty per page, with price, promotion price, sales, rating and shipping. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: iphone
          description: Search keyword
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (20 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: default
          description: A sort value from the response's sorts list
        - name: category_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Category id from aliexpress/categories
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price
        - name: ship_from
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Ship-from country code
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Storefront country
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/search-hot:
    get:
      operationId: aliexpress_search_hot
      tags:
        - AliExpress
      summary: AliExpress hot products
      description: Currently hot AliExpress products, optionally filtered by keyword or category, with prices, discount, sales volume and shop. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: xiaomi
          description: Keyword filter
        - name: category_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Category id filter
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: volume
          description: price_asc, price_desc, volume or discount
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Products per page, up to 50
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Ship-to country
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Price currency
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/search-promo:
    get:
      operationId: aliexpress_search_promo
      tags:
        - AliExpress
      summary: AliExpress promotion products
      description: Products in a named AliExpress promotion, with prices, discount, sales volume and shop. Costs 3 credits per successful live response.
      parameters:
        - name: promotion_name
          in: query
          required: true
          schema:
            type: string
          example: New Arrival
          description: A promotion name from aliexpress/promos
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Keyword filter
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Products per page, up to 50
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Ship-to country
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Price currency
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/shipping:
    get:
      operationId: aliexpress_shipping
      tags:
        - AliExpress
      summary: AliExpress shipping options
      description: "Shipping options for an AliExpress product to a country: carrier, fee, days and tracking. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3256804591426248"
          description: AliExpress item id
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Ship-to country
        - name: quantity
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Quantity
        - name: ext
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A variant's ext token from aliexpress/product, for variant-specific rates
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/similar:
    get:
      operationId: aliexpress_similar
      tags:
        - AliExpress
      summary: Similar AliExpress products
      description: Products similar to an AliExpress product (or to a keyword), from the marketplace's own matching. Costs 3 credits per successful live response.
      parameters:
        - name: product_id
          in: query
          required: false
          schema:
            type: string
          example: "3256806145778732"
          description: A product id or URL
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: headphones
          description: A keyword, when no product id is given
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Ship-to country
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Price currency
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/store:
    get:
      operationId: aliexpress_store
      tags:
        - AliExpress
      summary: AliExpress store
      description: "One AliExpress store: name, followers, product count, positive rate and seller level. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "231651707"
          description: Seller id from a product
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/aliexpress/store-products:
    get:
      operationId: aliexpress_store_products
      tags:
        - AliExpress
      summary: AliExpress store products
      description: Products of one AliExpress store, optionally matching a keyword. Costs 3 credits per successful live response.
      parameters:
        - name: seller_id
          in: query
          required: true
          schema:
            type: string
          example: "6003681832"
          description: Seller id from aliexpress/product's seller block
        - name: store_id
          in: query
          required: true
          schema:
            type: string
          example: "1105134056"
          description: Store id from the same seller block
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Keyword within the store
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A sort value from the response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/best-sellers:
    get:
      operationId: amazon_best_sellers
      tags:
        - Amazon
      summary: Amazon best sellers
      description: "A marketplace best-seller chart: rank, product, price, rating and rank movement. Costs 2 credits per successful live response."
      parameters:
        - name: category
          in: query
          required: true
          schema:
            type: string
          example: software
          description: Best-sellers category or subcategory path
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Marketplace country code (default GB)
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: BEST_SELLERS
          description: BEST_SELLERS, NEW_RELEASES, MOVERS_AND_SHAKERS, MOST_WISHED_FOR or GIFT_IDEAS
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 50
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/categories:
    get:
      operationId: amazon_categories
      tags:
        - Amazon
      summary: Amazon departments
      description: The marketplace's departments with the ids the product search takes. Costs 1 credit per successful live response.
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Marketplace country code (default GB)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/deals:
    get:
      operationId: amazon_deals
      tags:
        - Amazon
      summary: Amazon deals
      description: The marketplace deals feed with deal and list price, savings, badge, state and timing. Costs 2 credits per successful live response.
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Marketplace country code (default GB)
        - name: categories
          in: query
          required: false
          schema:
            type: string
          example: electronics
          description: Departments, comma-separated
        - name: brands
          in: query
          required: false
          schema:
            type: string
          example: Anker
          description: Brands, comma-separated
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Offset from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/product:
    get:
      operationId: amazon_product
      tags:
        - Amazon
      summary: Amazon product
      description: "One Amazon product by ASIN: title, description, images, price, rating, brand, categories and availability. Queued task. Costs 5 credits per successful live response."
      parameters:
        - name: asin
          in: query
          required: true
          schema:
            type: string
          example: B0CHX3QBCH
          description: ASIN, or an Amazon product URL
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name (sets the marketplace)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/reviews:
    get:
      operationId: amazon_reviews
      tags:
        - Amazon
      summary: Amazon reviews
      description: Reviews of an Amazon product with rating, text, date, verification and helpful votes. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: asin
          in: query
          required: true
          schema:
            type: string
          example: B0CHX3QBCH
          description: ASIN, or an Amazon product URL
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: recent
          description: helpful or recent
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/search:
    get:
      operationId: amazon_search
      tags:
        - Amazon
      summary: Amazon product search
      description: Products for a query on Amazon with price range, rating, review count, badges and delivery. Queued task. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: standing desk
          description: Search terms
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name (sets the marketplace)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: department
          in: query
          required: false
          schema:
            type: string
          example: Electronics
          description: Amazon department
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/seller:
    get:
      operationId: amazon_seller
      tags:
        - Amazon
      summary: Amazon seller profile
      description: A marketplace seller's public profile with rating, positive percentage and feedback summary. Contact details are never included. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: AY7AQ12Q1GTNE
          description: Seller id (from a product's seller or offers)
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Marketplace country code (default GB)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/seller-products:
    get:
      operationId: amazon_seller_products
      tags:
        - Amazon
      summary: Amazon seller listings
      description: The products a marketplace seller lists, with price, rating and badges. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: AY7AQ12Q1GTNE
          description: Seller id
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Marketplace country code (default GB)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/seller-reviews:
    get:
      operationId: amazon_seller_reviews
      tags:
        - Amazon
      summary: Amazon seller feedback
      description: Feedback left for a marketplace seller with rating, text, date and whether the seller responded. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: AY7AQ12Q1GTNE
          description: Seller id
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Marketplace country code (default GB)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/sellers:
    get:
      operationId: amazon_sellers
      tags:
        - Amazon
      summary: Amazon sellers
      description: Every seller offering an Amazon product with price, condition, shipping and seller rating. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: asin
          in: query
          required: true
          schema:
            type: string
          example: B0CHX3QBCH
          description: ASIN, or an Amazon product URL
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/amazon/shop:
    get:
      operationId: amazon_shop
      tags:
        - Amazon
      summary: Amazon shop page
      description: "An Amazon shop page: the storefront profile, its posts (idea lists, photos, videos) and the products of its first idea list with prices and ratings. Costs 2 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.amazon.com/shop/tastemade
          description: An Amazon shop (influencer storefront) page URL, or the shop name
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Amazon marketplace
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/app_store/app-info:
    get:
      operationId: app_store_app_info
      tags:
        - App Store
      summary: App Store app details
      description: "Full App Store app record: description, price, ratings, genres, screenshots, current version, release notes and size. similar_apps and more_apps_by_developer are filled only when the answering source supplies them (related_apps_included says which); the official store lookup does not carry them. Costs 1 credit per successful live response."
      parameters:
        - name: app_id
          in: query
          required: true
          schema:
            type: string
          example: "324684580"
          description: Numeric App Store track id, or a bundle id like com.spotify.client
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: 2-letter storefront country code (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Result language code (e.g. en_us, ja_jp)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/app_store/app-list:
    get:
      operationId: app_store_app_list
      tags:
        - App Store
      summary: App Store top charts
      description: Apple Marketing Tools top-free / top-paid app chart for a storefront, ranked. Costs 2 credits per successful live response.
      parameters:
        - name: app_collection
          in: query
          required: true
          schema:
            type: string
          example: top-free
          description: top-free or top-paid (aliases topfreeapplications / toppaidapplications accepted)
        - name: app_category
          in: query
          required: false
          schema:
            type: string
          example: "6014"
          description: Not supported by the Apple charts feed; acknowledged in _warnings and ignored
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: 2-letter storefront country code (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Not supported by the charts feed; acknowledged in _warnings and ignored
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Number of chart entries to return (max 100)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/app_store/app-reviews:
    get:
      operationId: app_store_app_reviews
      tags:
        - App Store
      summary: App Store app reviews
      description: "Customer reviews for an app from the per-storefront Apple reviews feed: rating, title, text, author and app version. Costs 2 credits per successful live response."
      parameters:
        - name: app_id
          in: query
          required: true
          schema:
            type: string
          example: "324684580"
          description: Numeric App Store track id
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: 2-letter storefront country code (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Not supported by the Apple reviews feed; acknowledged in _warnings and ignored
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Pages of up to 50 reviews to fetch (max 5)
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: mostrecent
          description: mostrecent (default) or mosthelpful
        - name: rating
          in: query
          required: false
          schema:
            type: string
          example: "5"
          description: 1-5; filter applied locally after fetch (noted in _warnings)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/app_store/app-search:
    get:
      operationId: app_store_app_search
      tags:
        - App Store
      summary: App Store app search
      description: Search Apple App Store apps by keyword — name, developer, price, rating and genre per hit. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: spotify
          description: Search keywords
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: 2-letter storefront country code (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Result language code (e.g. en_us, ja_jp)
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Number of results to return (max 100)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/app_store/categories:
    get:
      operationId: app_store_categories
      tags:
        - App Store
      summary: App Store categories
      description: Reference list of Apple App Store genre ids (6xxx) and Games sub-genres (7xxx). Static, costs no credits. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/app_store/languages:
    get:
      operationId: app_store_languages
      tags:
        - App Store
      summary: App Store languages
      description: Reference list of iTunes Search API language codes (lang parameter). Static, costs no credits. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/app_store/locations:
    get:
      operationId: app_store_locations
      tags:
        - App Store
      summary: App Store storefronts
      description: Reference list of Apple App Store storefront country codes. Static, costs no credits. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/app_store/search-suggestions:
    get:
      operationId: app_store_search_suggestions
      tags:
        - App Store
      summary: App Store search suggestions
      description: The search terms the App Store suggests for a partial query, in the order the store ranks them. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: spotify
          description: Partial search term
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: 2-letter storefront country code (default us)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/apple_music/album:
    get:
      operationId: apple_music_album
      tags:
        - Apple Music
      summary: Get an Apple Music album
      description: Look up one Apple Music album by id or music.apple.com URL, including its full track listing. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: "697194953"
          description: Apple Music album id (this or url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://music.apple.com/us/album/discovery/697194953
          description: music.apple.com album URL (this or id)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/apple_music/artist:
    get:
      operationId: apple_music_artist
      tags:
        - Apple Music
      summary: Get an Apple Music artist
      description: Look up one Apple Music artist by id or music.apple.com URL. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: "5468295"
          description: Apple Music artist id (this or url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://music.apple.com/us/artist/daft-punk/5468295
          description: music.apple.com artist URL (this or id)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/apple_music/search:
    get:
      operationId: apple_music_search
      tags:
        - Apple Music
      summary: Search Apple Music
      description: Search Apple Music artists, albums, and tracks by keyword. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: daft punk
          description: Search terms
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: artist
          description: "Restrict results: artist, album, or track (omit for all music)"
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Max results, 1-50 (default 25)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/apple_music/track:
    get:
      operationId: apple_music_track
      tags:
        - Apple Music
      summary: Get an Apple Music track
      description: Look up one Apple Music track by id or music.apple.com URL, with preview audio and album context. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: "697195462"
          description: Apple Music track id (this or url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://music.apple.com/us/album/discovery/697194953?i=697195462
          description: music.apple.com track or album?i= URL (this or id)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/bluesky/post:
    get:
      operationId: bluesky_post
      tags:
        - Bluesky
      summary: Bluesky post
      description: "Fetch a single Bluesky post from its bsky.app URL: text, author and like/repost/reply/quote counts. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://bsky.app/profile/bsky.app/post/3juzlwllznd24
          description: bsky.app post link or at:// post URI
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/bluesky/profile:
    get:
      operationId: bluesky_profile
      tags:
        - Bluesky
      summary: Bluesky profile
      description: "Fetch a Bluesky profile by handle or DID: display name, bio, follower/following/post counts and avatar. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: bsky.app
          description: Bluesky handle (e.g. alice.bsky.social) or DID
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/bluesky/search:
    get:
      operationId: bluesky_search
      tags:
        - Bluesky
      summary: Bluesky post search
      description: Full-text search over public Bluesky posts with engagement counts. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: nextjs
          description: Search text
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Max results (1-100)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: latest
          description: top or latest
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Continue a previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/bluesky/user/posts:
    get:
      operationId: bluesky_user_posts
      tags:
        - Bluesky
      summary: Bluesky user posts
      description: List a Bluesky account's posts (newest first) with like/repost/reply/quote counts; reposts are included and labeled is_repost. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: bsky.app
          description: Bluesky handle (provide this or user_id)
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          example: did:plc:z72i7hdynmk6r22z27h6tvur
          description: Account DID (provide this or handle)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Posts per page, 1-100 (default 25)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from a previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/attraction:
    get:
      operationId: booking_attraction
      tags:
        - Booking.com
      summary: Booking.com attraction
      description: "One attraction's page: description, price, rating and reviews, cancellation, operator, what is included and not, languages, photos, meeting and departure addresses, offers and the latest reviews. Costs 3 credits per successful live response."
      parameters:
        - name: slug
          in: query
          required: true
          schema:
            type: string
          example: pr4z1zrjq9hl-skip-the-queue-tickets-into-the-lisbon-oceanarium
          description: The attraction's slug from booking/search-attractions (or pass url, its page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The attraction's page URL instead of a slug
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/attraction-locations:
    get:
      operationId: booking_attraction_locations
      tags:
        - Booking.com
      summary: Booking.com attractions lookup
      description: The attractions destinations the site knows for a name, each with the id booking/search-attractions takes and how many things to do it holds, plus the named attractions that match. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Lisbon
          description: A city or an attraction name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/flight-locations:
    get:
      operationId: booking_flight_locations
      tags:
        - Booking.com
      summary: Booking.com airport lookup
      description: The airports and cities the flight search knows for a name, each with the code booking/search-flights takes (LHR.AIRPORT, LON.CITY). Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: London
          description: A city or airport name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/hotel:
    get:
      operationId: booking_hotel
      tags:
        - Booking.com
      summary: Booking.com hotel
      description: "One hotel's page for a stay: address and position, type, the price with its per-night and all-inclusive figures, facilities and highlights, breakfast and Wi-Fi scores, sustainability tier, the important information, each room with its beds, facilities and photos, and every bookable offer with its cancellation and prepayment terms. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4045490"
          description: The hotel's number, from booking/search-hotels
        - name: checkin
          in: query
          required: true
          schema:
            type: string
          example: "2026-10-10"
          description: Check-in date, YYYY-MM-DD
        - name: checkout
          in: query
          required: true
          schema:
            type: string
          example: "2026-10-12"
          description: Check-out date, YYYY-MM-DD
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults, 1 to 30
        - name: children_ages
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children's ages, separated by commas
        - name: rooms
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Rooms, 1 to 30
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-gb
          description: Language code for the site's text
        - name: units
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: metric or imperial
        - name: temperature_unit
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: c or f
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/hotel-availability:
    get:
      operationId: booking_hotel_availability
      tags:
        - Booking.com
      summary: Booking.com nightly prices
      description: The nights a hotel has available between two dates, each with its price and minimum stay. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4045490"
          description: The hotel's number, from booking/search-hotels
        - name: from
          in: query
          required: true
          schema:
            type: string
          example: "2026-12-20"
          description: First date, YYYY-MM-DD
        - name: to
          in: query
          required: true
          schema:
            type: string
          example: "2026-12-31"
          description: Last date, YYYY-MM-DD
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults, 1 to 30
        - name: rooms
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Rooms, 1 to 30
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/hotel-review-scores:
    get:
      operationId: booking_hotel_review_scores
      tags:
        - Booking.com
      summary: Booking.com review scores
      description: "How one hotel's score breaks down: by traveller type and question (cleanliness, staff, location…) against the area's average, by score band, and the distribution of scores. Costs 2 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4045490"
          description: The hotel's number, from booking/search-hotels
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-us
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/hotel-reviews:
    get:
      operationId: booking_hotel_reviews
      tags:
        - Booking.com
      summary: Booking.com hotel reviews
      description: "Guest reviews of one hotel: title, what they liked and disliked, score, date, purpose of travel, the reviewer's country and traveller type, the room and nights they stayed, photos and the hotel's reply. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4045490"
          description: The hotel's number, from booking/search-hotels
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (25 a page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: relevant
          description: relevant, newest, oldest, highest or lowest
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-us
          description: Language code for the site's text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/hotel-rooms:
    get:
      operationId: booking_hotel_rooms
      tags:
        - Booking.com
      summary: Booking.com rooms and offers
      description: "One hotel's rooms for a stay and every bookable offer on them: price with its per-night and all-inclusive figures, occupancy, size, meal plan, cancellation and prepayment terms, deposit, and how many are left. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4045490"
          description: The hotel's number, from booking/search-hotels
        - name: checkin
          in: query
          required: true
          schema:
            type: string
          example: "2026-10-10"
          description: Check-in date, YYYY-MM-DD
        - name: checkout
          in: query
          required: true
          schema:
            type: string
          example: "2026-10-12"
          description: Check-out date, YYYY-MM-DD
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults, 1 to 30
        - name: children_ages
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children's ages, separated by commas
        - name: rooms
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Rooms, 1 to 30
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-gb
          description: Language code for the site's text
        - name: units
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: metric or imperial
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/locations:
    get:
      operationId: booking_locations
      tags:
        - Booking.com
      summary: Booking.com destination lookup
      description: "The destinations the site knows for a name: cities, districts, landmarks and hotels, each with the id and type booking/search-hotels takes and how many hotels it holds. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Manhattan
          description: A city, district, landmark or hotel name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/search-attractions:
    get:
      operationId: booking_search_attractions
      tags:
        - Booking.com
      summary: Booking.com things to do
      description: "Things to do in a destination: name, description, price, free cancellation, rating and review count, photo and the city. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Lisbon
          description: A city; resolved to a destination once and remembered (or pass destination_id)
        - name: destination_id
          in: query
          required: false
          schema:
            type: string
          example: eyJ1ZmkiOi0yMTY3OTczfQ==
          description: A destination id from booking/attraction-locations
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: trending
          description: trending, attr_book_score or lowest_price
        - name: start_date
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: First date, YYYY-MM-DD
        - name: end_date
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Last date, YYYY-MM-DD
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Language code for the site's text
        - name: types
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's type filters, separated by commas
        - name: labels
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's label filters, separated by commas
        - name: prices
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's price filters, separated by commas
        - name: areas
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's area filters, separated by commas
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/search-flights:
    get:
      operationId: booking_search_flights
      tags:
        - Booking.com
      summary: Booking.com flight search
      description: "Flights between two places: each offer's price with its base fare and tax, seats left, and every segment and leg with airports, times, carrier, flight number, cabin and luggage allowance; plus the search's summary (cheapest fare, airlines, stops). Costs 3 credits per successful live response."
      parameters:
        - name: from
          in: query
          required: true
          schema:
            type: string
          example: LON.CITY
          description: Departure place code from booking/flight-locations
        - name: to
          in: query
          required: true
          schema:
            type: string
          example: LIS.AIRPORT
          description: Arrival place code from booking/flight-locations
        - name: depart_date
          in: query
          required: true
          schema:
            type: string
          example: "2026-11-25"
          description: Outbound date, YYYY-MM-DD
        - name: return_date
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Return date, YYYY-MM-DD, for a round trip
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Adults, 1 to 9
        - name: children_ages
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children's ages, separated by commas
        - name: cabin
          in: query
          required: false
          schema:
            type: string
          example: economy
          description: economy, premium_economy, business or first
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: best
          description: best, cheapest or fastest
        - name: stops
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: none, 0, 1 or 2
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/booking/search-hotels:
    get:
      operationId: booking_search_hotels
      tags:
        - Booking.com
      summary: Booking.com hotel search
      description: "Hotels in a destination for a stay: name, stars, review score and count, the price for the stay, check-in and check-out times, position, photos and whether the site prefers it. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Lisbon
          description: A city, district, landmark or hotel name; resolved to a destination once and remembered (or pass destination_id and destination_type)
        - name: destination_id
          in: query
          required: false
          schema:
            type: string
          example: "-2167973"
          description: A destination id from booking/locations
        - name: destination_type
          in: query
          required: false
          schema:
            type: string
          example: CITY
          description: The destination's type from booking/locations
        - name: checkin
          in: query
          required: true
          schema:
            type: string
          example: "2026-10-10"
          description: Check-in date, YYYY-MM-DD
        - name: checkout
          in: query
          required: true
          schema:
            type: string
          example: "2026-10-12"
          description: Check-out date, YYYY-MM-DD
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults, 1 to 30
        - name: children_ages
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Children's ages, separated by commas
        - name: rooms
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Rooms, 1 to 30
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: popularity, price, class, review_score or distance
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price per night in the currency
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price per night in the currency
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The site's category filters, separated by commas (class::4, free_cancellation::1…)
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: GBP
          description: Three-letter currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-gb
          description: Language code for the site's text
        - name: units
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: metric or imperial
        - name: temperature_unit
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: c or f
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/cohort-queries/delete:
    get:
      operationId: cohort_queries_delete
      tags:
        - Cohort Queries
      summary: Delete a cohort query
      description: Delete one of your cohort sweeps and its results. A sweep still queued is cancelled and refunded; one already running is cancelled and its charge stands. Free — costs 0 credits.
      parameters:
        - name: query_id
          in: query
          required: true
          schema:
            type: string
          example: cq_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Cohort query id (the {queryId} path segment)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/cohort-queries/get:
    get:
      operationId: cohort_queries_get
      tags:
        - Cohort Queries
      summary: Check cohort query status
      description: The status of one cohort keyword sweep, with per-member progress while it runs. Free — costs 0 credits.
      parameters:
        - name: query_id
          in: query
          required: true
          schema:
            type: string
          example: cq_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Cohort query id (the {queryId} path segment)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/cohort-queries/results:
    get:
      operationId: cohort_queries_results
      tags:
        - Cohort Queries
      summary: Read cohort query results
      description: The keyword matches a finished cohort sweep found, per member, newest page first. Free — costs 0 credits.
      parameters:
        - name: query_id
          in: query
          required: true
          schema:
            type: string
          example: cq_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Cohort query id (the {queryId} path segment)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page of matches
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Matches per page, 1-100 (default 25)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/cohorts/create:
    get:
      operationId: cohorts_create
      tags:
        - Cohorts
      summary: Create a cohort
      description: Save a set of up to 100 accounts, subreddits or handles as a cohort you can sweep with one keyword. Costs 1 credit per successful live response.
      parameters:
        - name: name
          in: query
          required: true
          schema:
            type: string
          example: Rust ecosystem
          description: Human label for this cohort (max 200 characters)
        - name: members
          in: query
          required: true
          schema:
            type: string
          example: reddit:rust,hackernews:steveklabnik,github:rust-lang/rust,bluesky:rust-lang.bsky.social
          description: "The accounts to sweep: a comma-separated platform:identifier list, or a JSON array of {\"platform\",\"identifier\"} objects. 1-100 members; every platform must exist in the catalogue."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/cohorts/delete:
    get:
      operationId: cohorts_delete
      tags:
        - Cohorts
      summary: Delete a cohort
      description: Delete one of your cohorts and every query it ran. A running sweep is cancelled first; its charge is refunded only if it had not started. Free — costs 0 credits.
      parameters:
        - name: cohort_id
          in: query
          required: true
          schema:
            type: string
          example: coh_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Cohort id (the {cohortId} path segment)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/cohorts/get:
    get:
      operationId: cohorts_get
      tags:
        - Cohorts
      summary: Get a cohort
      description: One cohort with its members and the most recent keyword queries run against it. Free — costs 0 credits.
      parameters:
        - name: cohort_id
          in: query
          required: true
          schema:
            type: string
          example: coh_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Cohort id (the {cohortId} path segment)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/cohorts/members:
    get:
      operationId: cohorts_members
      tags:
        - Cohorts
      summary: Replace a cohort's members
      description: Replace a cohort's member list in one call. Sweeps already completed keep the results they produced. Free — costs 0 credits.
      parameters:
        - name: cohort_id
          in: query
          required: true
          schema:
            type: string
          example: coh_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Cohort id (the {cohortId} path segment)
        - name: members
          in: query
          required: true
          schema:
            type: string
          example: reddit:rust,hackernews:steveklabnik,github:rust-lang/rust
          description: "The new member list, replacing the old one entirely: a comma-separated platform:identifier list, or a JSON array of {\"platform\",\"identifier\"} objects. 1-100 members; every platform must exist in the catalogue."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/cohorts/queries:
    get:
      operationId: cohorts_queries
      tags:
        - Cohorts
      summary: Submit a cohort query
      description: "Run one keyword across every member of a cohort. Asynchronous: returns a query id to poll. Costs 10 credits per successful live response."
      parameters:
        - name: cohort_id
          in: query
          required: true
          schema:
            type: string
          example: coh_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Cohort id (the {cohortId} path segment)
        - name: keyword
          in: query
          required: true
          schema:
            type: string
          example: async runtime
          description: The keyword swept across every member of the cohort (max 200 characters)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/companies_house/company:
    get:
      operationId: companies_house_company
      tags:
        - Companies House
      summary: Company profile
      description: "Full register entry: status, type, incorporation date, registered office, SIC codes, accounts and filing due dates. Costs 1 credit per successful live response."
      parameters:
        - name: number
          in: query
          required: true
          schema:
            type: string
          example: "11364012"
          description: Eight-character company number.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/companies_house/officers:
    get:
      operationId: companies_house_officers
      tags:
        - Companies House
      summary: Company officers
      description: "Directors and secretaries: role, appointment and resignation dates, nationality, and month/year of birth only. Costs 1 credit per successful live response."
      parameters:
        - name: number
          in: query
          required: true
          schema:
            type: string
          example: "11364012"
          description: Eight-character company number.
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results per page, 1–100 (default 20).
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/companies_house/search:
    get:
      operationId: companies_house_search
      tags:
        - Companies House
      summary: Company search
      description: Search the UK register by company name or number. Returns number, status, type and incorporation date. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: NTV LTD
          description: Company name or number to search for.
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results per page, 1–100 (default 20).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Opaque cursor from a previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/categories:
    get:
      operationId: content_analysis_categories
      tags:
        - Content Analysis
      summary: Content Analysis categories
      description: Monocrawl's own mention-classification taxonomy (taxonomy id monocrawl.content_analysis.v1), including the full keyword list behind each category so any classification can be audited. Static, costs no credits. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/filters:
    get:
      operationId: content_analysis_filters
      tags:
        - Content Analysis
      summary: Content Analysis filters
      description: The filterable fields for the content analysis endpoints — field, type, operators, allowed values, which endpoints accept it and whether it is applied upstream or locally. Generated from the adapter's own filter implementation, so it cannot drift. Static, costs no credits. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/languages:
    get:
      operationId: content_analysis_languages
      tags:
        - Content Analysis
      summary: Content Analysis languages
      description: Reference list of the ISO-639-1 language codes content analysis can genuinely filter on, each marked with which source honours it. Static, costs no credits. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/locations:
    get:
      operationId: content_analysis_locations
      tags:
        - Content Analysis
      summary: Content Analysis locations
      description: Reference list of the ISO-3166 alpha-2 country codes content analysis can genuinely filter on — publisher country for news, storefront for rating-distribution. Static, costs no credits. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/phrase-trends:
    get:
      operationId: content_analysis_phrase_trends
      tags:
        - Content Analysis
      summary: Keyword mention trends
      description: Mention volume and sentiment for a keyword bucketed by day, week or month across the sources we can reach. Bucket heights are bounded by each source's per-query cap, so the series is a shape, not a census — the response says so explicitly. Costs 5 credits per successful live response.
      parameters:
        - name: keyword
          in: query
          required: true
          schema:
            type: string
          example: kubernetes
          description: Phrase to trend
        - name: date_from
          in: query
          required: true
          schema:
            type: string
          example: "2026-08-01"
          description: ISO-8601 start of the window
        - name: date_to
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-31"
          description: ISO-8601 end of the window (default now)
        - name: date_group
          in: query
          required: false
          schema:
            type: string
          example: day
          description: day (default), week or month; max 400 buckets
        - name: page_type
          in: query
          required: false
          schema:
            type: string
          example: all
          description: all, news, forum, social or discussion
        - name: internal_list_limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Length of the embedded top-terms list (max 50)
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "100"
          description: Items fetched PER SOURCE before bucketing (max 100)
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: source:eq:hackernews
          description: field:op:value segments joined by ; — see /v1/content_analysis/filters
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/rating-distribution:
    get:
      operationId: content_analysis_rating_distribution
      tags:
        - Content Analysis
      summary: Keyword rating distribution
      description: Real 1-5 star histogram for a keyword that resolves to an App Store app, built from actual published reviews plus Apple's own lifetime average. If the keyword resolves to nothing rateable it returns 404 — no histogram is ever synthesised. Costs 3 credits per successful live response.
      parameters:
        - name: keyword
          in: query
          required: true
          schema:
            type: string
          example: Spotify
          description: Name of a rateable entity — currently an App Store app
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: 2-letter App Store storefront (default us); filters=location_code:eq:gb works too
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "3"
          description: Pages of up to 50 reviews to sample (max 5)
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: location_code:eq:gb
          description: Only location_code applies here — see /v1/content_analysis/filters
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/search:
    get:
      operationId: content_analysis_search
      tags:
        - Content Analysis
      summary: Keyword mention search
      description: Web citations of a keyword from news, Hacker News and Reddit with deterministic per-mention sentiment (in-adapter lexicon, no AI), Monocrawl category labels and per-source provenance. Fans out to 3 upstreams; coverage is partial and every response names what it could not consult. Costs 3 credits per successful live response.
      parameters:
        - name: keyword
          in: query
          required: true
          schema:
            type: string
          example: kubernetes
          description: Phrase to find mentions of
        - name: page_type
          in: query
          required: false
          schema:
            type: string
          example: all
          description: all, news, forum, social or discussion — maps onto our source roster; review/blog/ecommerce classes are rejected with an explanation rather than silently served from the wrong sources
        - name: search_mode
          in: query
          required: false
          schema:
            type: string
          example: as_is
          description: as_is (default) or one_per_domain (keep the first mention per publisher)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Mentions per page after merging (max 100)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Offset into the merged result set, from a previous response
        - name: order_by
          in: query
          required: false
          schema:
            type: string
          example: published_at:desc
          description: published_at:desc|asc, sentiment:desc|asc, source or relevance
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items fetched PER SOURCE before merging (max 100)
        - name: positive_connotation_threshold
          in: query
          required: false
          schema:
            type: string
          example: "0.25"
          description: Score in (0,1] at or above which a mention is labelled positive
        - name: sentiments_connotation_threshold
          in: query
          required: false
          schema:
            type: string
          example: "0.25"
          description: Score magnitude at or below which a mention is labelled negative
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: source:in:hackernews,reddit;sentiment:eq:negative
          description: field:op:value segments joined by ; — see /v1/content_analysis/filters
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/sentiment:
    get:
      operationId: content_analysis_sentiment
      tags:
        - Content Analysis
      summary: Keyword sentiment breakdown
      description: Positive / neutral / negative split for a keyword with mean, median and a score histogram, plus the most positive and most negative mentions. Lexicon-based and fully deterministic — the method, its thresholds and its limits are returned with every response. Costs 3 credits per successful live response.
      parameters:
        - name: keyword
          in: query
          required: true
          schema:
            type: string
          example: kubernetes
          description: Phrase to score
        - name: page_type
          in: query
          required: false
          schema:
            type: string
          example: all
          description: all, news, forum, social or discussion
        - name: positive_connotation_threshold
          in: query
          required: false
          schema:
            type: string
          example: "0.25"
          description: Score in (0,1] at or above which a mention is positive
        - name: sentiments_connotation_threshold
          in: query
          required: false
          schema:
            type: string
          example: "0.25"
          description: Score magnitude at or below which a mention is negative
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Items fetched PER SOURCE before aggregating (max 100)
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: source:eq:hackernews
          description: field:op:value segments joined by ; — see /v1/content_analysis/filters
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/content_analysis/summary:
    get:
      operationId: content_analysis_summary
      tags:
        - Content Analysis
      summary: Keyword mention summary
      description: "Aggregate view of a keyword's mentions: volume, per-source breakdown, sentiment split, category mix, top publishers and top terms — all computed deterministically from the mentions we could reach. Costs 3 credits per successful live response."
      parameters:
        - name: keyword
          in: query
          required: true
          schema:
            type: string
          example: kubernetes
          description: Phrase to summarise mentions of
        - name: page_type
          in: query
          required: false
          schema:
            type: string
          example: all
          description: all, news, forum, social or discussion
        - name: positive_connotation_threshold
          in: query
          required: false
          schema:
            type: string
          example: "0.25"
          description: Score in (0,1] at or above which a mention is positive
        - name: sentiments_connotation_threshold
          in: query
          required: false
          schema:
            type: string
          example: "0.25"
          description: Score magnitude at or below which a mention is negative
        - name: internal_list_limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Length of the embedded top-terms / category / publisher lists (max 50)
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Items fetched PER SOURCE before aggregating (max 100)
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: category:eq:reliability_outage
          description: field:op:value segments joined by ; — see /v1/content_analysis/filters
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/credits/balance:
    get:
      operationId: credits_balance
      tags:
        - Credits
      summary: Credit balance
      description: "Your current credit balance: credits remaining, lifetime credits, and when the balance last changed. Free to call. Free — costs 0 credits."
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/credits/transactions:
    get:
      operationId: credits_transactions
      tags:
        - Credits
      summary: Credit transactions
      description: "Your credit ledger, newest first: grants, purchases, spends and refunds with the balance after each. Cursor-paginated; free to call. Free — costs 0 credits."
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Rows per page (default 25, max 100)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "18432"
          description: Opaque cursor from the previous page
        - name: request_id
          in: query
          required: false
          schema:
            type: string
          example: req_1a2b3c
          description: Only ledger rows tied to this API request id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/ebay/product:
    get:
      operationId: ebay_product
      tags:
        - eBay
      summary: Get an eBay listing
      description: "Look up one eBay listing by item id or ebay.com/itm URL: full price, condition, seller, item specifics, availability, shipping, returns, and ratings. Costs 1 credit per successful live response."
      parameters:
        - name: product_id
          in: query
          required: true
          schema:
            type: string
          example: "110550372627"
          description: "eBay item id: a numeric legacy id, a v1|…|… RESTful id, or an ebay.com/itm/ URL"
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: "Marketplace: a country code (us, gb, de…) or a raw eBay marketplace id (EBAY_US). Default us."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/ebay/search:
    get:
      operationId: ebay_search
      tags:
        - eBay
      summary: Search eBay listings
      description: "Search live eBay listings by keyword: title, price, condition, seller, shipping, and thumbnails, with filters for price, condition, and buying format. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: iphone 11
          description: Keywords to search listing titles for
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: "Marketplace: a country code (us, gb, de, au, ca, fr…) or a raw eBay marketplace id (EBAY_US). Default us."
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: 1-based page number (mapped to offset = (page-1)*limit); use cursor to paginate reliably
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: price_asc
          description: "Best-effort sort: price_asc, price_desc, newest, or distance (unrecognized values are ignored)"
        - name: condition
          in: query
          required: false
          schema:
            type: string
          example: new
          description: "Item condition filter, comma-separated: new, used, refurbished, open_box, for_parts"
        - name: buying_format
          in: query
          required: false
          schema:
            type: string
          example: auction
          description: "Buying format filter, comma-separated: fixed_price, auction, best_offer, classified_ad"
        - name: show_only
          in: query
          required: false
          schema:
            type: string
          example: free_shipping
          description: "Extra filters, comma-separated: free_shipping, returns_accepted, authenticity_guarantee"
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Minimum price in the marketplace currency
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: "500"
          description: Maximum price in the marketplace currency
        - name: aspects
          in: query
          required: false
          schema:
            type: string
          example: Brand:{Apple}
          description: Raw eBay aspect_filter expression to narrow by item aspects
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Opaque pagination cursor returned by the previous page (a stringified offset)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/categories:
    get:
      operationId: etsy_categories
      tags:
        - Etsy
      summary: Etsy categories
      description: The Etsy category tree, or one branch of it. Costs 1 credit per successful live response.
      parameters:
        - name: parent_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Parent category id for its children
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Tree depth, 1-3
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Category name search
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/category-products:
    get:
      operationId: etsy_category_products
      tags:
        - Etsy
      summary: Etsy category listings
      description: Listings in an Etsy category, 64 per page. Costs 3 credits per successful live response.
      parameters:
        - name: path
          in: query
          required: true
          schema:
            type: string
          example: jewelry/necklaces
          description: Category path, or its etsy.com/c/ URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (64 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: relevancy, most_recent, price_asc, price_desc or highest_reviews
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/product:
    get:
      operationId: etsy_product
      tags:
        - Etsy
      summary: Etsy listing
      description: "One Etsy listing: title, description, price, availability, images, tags, materials, category, shop, favourites, views and recent reviews. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4429284280"
          description: Etsy listing id, or its URL
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-US
          description: Language
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/reviews:
    get:
      operationId: etsy_reviews
      tags:
        - Etsy
      summary: Etsy listing reviews
      description: Reviews of an Etsy listing, eight per page, with the rating distribution and review themes. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4429284280"
          description: Etsy listing id, or its URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (8 per page)
        - name: scope
          in: query
          required: false
          schema:
            type: string
          example: listing
          description: listing or shop
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: relevancy
          description: relevancy, recency, highest or lowest
        - name: rating
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only this star rating (1-5)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/search:
    get:
      operationId: etsy_search
      tags:
        - Etsy
      summary: Etsy listing search
      description: Listings matching a keyword, twelve per page, with price, discount, shop, rating and badges. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: wool socks
          description: Search keyword
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (12 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: relevancy
          description: relevancy, most_recent, price_asc, price_desc or highest_reviews
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price
        - name: ship_to
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Two-letter country
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-US
          description: Language
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/shop:
    get:
      operationId: etsy_shop
      tags:
        - Etsy
      summary: Etsy shop
      description: "One Etsy shop: sales, rating, seller, location, listing counts and sections. Costs 1 credit per successful live response."
      parameters:
        - name: shop
          in: query
          required: true
          schema:
            type: string
          example: Qorux
          description: Shop name, numeric id or URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/shop-products:
    get:
      operationId: etsy_shop_products
      tags:
        - Etsy
      summary: Etsy shop listings
      description: The listings of an Etsy shop, with price, discount, badges and processing time. Costs 3 credits per successful live response.
      parameters:
        - name: shop
          in: query
          required: true
          schema:
            type: string
          example: Qorux
          description: Shop name, numeric id or URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "24"
          description: Up to 48 per page
        - name: section_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A section id from etsy/shop
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: created
          description: created, price_asc, price_desc or score
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/shop-reviews:
    get:
      operationId: etsy_shop_reviews
      tags:
        - Etsy
      summary: Etsy shop reviews
      description: Reviews of an Etsy shop across its listings, eight per page. Costs 3 credits per successful live response.
      parameters:
        - name: shop
          in: query
          required: true
          schema:
            type: string
          example: Qorux
          description: Shop name, numeric id or URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (8 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: recency
          description: recency, relevancy, highest or lowest
        - name: rating
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only this star rating (1-5)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/shops:
    get:
      operationId: etsy_shops
      tags:
        - Etsy
      summary: Etsy shop search
      description: Shops matching a keyword, twelve per page. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: ceramic
          description: Search keyword
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (12 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: most_relevant
          description: most_relevant, most_recent or alphabetical
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/etsy/similar:
    get:
      operationId: etsy_similar
      tags:
        - Etsy
      summary: Etsy similar listings
      description: Listings similar to one listing. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4429284280"
          description: Etsy listing id, or its URL
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Up to 48
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/etsy/suggestions:
    get:
      operationId: etsy_suggestions
      tags:
        - Etsy
      summary: Etsy search suggestions
      description: Search suggestions for a partial query, with the categories each suggests. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: gift
          description: Partial search text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/city-events:
    get:
      operationId: facebook_city_events
      tags:
        - Facebook
      summary: Facebook city events
      description: "The public events on a city's Facebook events page, one page at a time and optionally limited to today, this week or next week: name, when, where, kind, cover, price range and interest counts. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/events/explore/saint-petersburg-florida/111326725552547
          description: A city's Facebook events page URL
        - name: time
          in: query
          required: false
          schema:
            type: string
          example: this_week
          description: today, this_week or next_week; omitted = all time
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/facebook/comment-replies:
    get:
      operationId: facebook_comment_replies
      tags:
        - Facebook
      summary: Comment replies
      description: The reply thread under one Facebook comment — chain feedback_id + expansion_token from facebook/post-comments. Facebook hides some reply threads; an empty list is the platform's real answer, not an error. Costs 1 credit per successful live response.
      parameters:
        - name: feedback_id
          in: query
          required: true
          schema:
            type: string
          description: feedback_id from a facebook/post-comments row.
        - name: expansion_token
          in: query
          required: true
          schema:
            type: string
          description: expansion_token from the same facebook/post-comments row.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/event:
    get:
      operationId: facebook_event
      tags:
        - Facebook
      summary: Facebook event
      description: "One event in full: description, timing, location and coordinates, attendance count, hosts, creator, ticket link and cover. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1234567890123456"
          description: Event id (or pass url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.facebook.com/events/1234567890123456
          description: Event URL, instead of id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/events:
    get:
      operationId: facebook_events
      tags:
        - Facebook
      summary: Facebook page events
      description: "The events a page has published, one page at a time: name, when, where, kind and whether it is online, past or cancelled. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/nasa
          description: Page URL
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/events-search:
    get:
      operationId: facebook_events_search
      tags:
        - Facebook
      summary: Facebook event search
      description: Public events matching a query, one page at a time. A search result carries the event id, name and link; this source lists no timing, place or flags, so those fields are null here. Read one event in full (timing, location, hosts, attendance) with facebook/event. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: astronomy night
          description: Search query
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/group:
    get:
      operationId: facebook_group
      tags:
        - Facebook
      summary: Group details
      description: "A public Facebook group: name, member count and description. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/groups/366190054572553/
          description: Facebook group URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/group-posts:
    get:
      operationId: facebook_group_posts
      tags:
        - Facebook
      summary: Group posts
      description: Recent posts in a public Facebook group with reaction and comment counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/groups/366190054572553/
          description: Facebook group URL.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: CHRONOLOGICAL or TOP_POSTS.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/marketplace-item:
    get:
      operationId: facebook_marketplace_item
      tags:
        - Facebook
      summary: Marketplace item
      description: "One Marketplace listing in full: description, photos, attributes, availability and price as displayed. Fields the seller did not publish stay null. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "28157874247229481"
          description: Listing id from facebook/marketplace-search (or pass url).
        - name: url
          in: query
          required: false
          schema:
            type: string
          description: Full marketplace item URL — alternative to id.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/marketplace-locations:
    get:
      operationId: facebook_marketplace_locations
      tags:
        - Facebook
      summary: Marketplace locations
      description: Resolve a place name to Marketplace-usable coordinates. Returns candidate locations with lat/lng — pick the right one before searching. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Austin
          description: City or place name to resolve.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/marketplace-search:
    get:
      operationId: facebook_marketplace_search
      tags:
        - Facebook
      summary: Marketplace search
      description: "Search Facebook Marketplace listings around a point: title, price, image and listing URL. Paged by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: bike
          description: What to search for.
        - name: lat
          in: query
          required: true
          schema:
            type: string
          example: "30.2672"
          description: Latitude from facebook/marketplace-locations.
        - name: lng
          in: query
          required: true
          schema:
            type: string
          example: "-97.7431"
          description: Longitude from facebook/marketplace-locations.
        - name: radius_km
          in: query
          required: false
          schema:
            type: string
          description: Search radius in km.
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          description: Minimum price.
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          description: Maximum price.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: e.g. creation_time_descend.
        - name: condition
          in: query
          required: false
          schema:
            type: string
          description: e.g. used_good.
        - name: date_listed
          in: query
          required: false
          schema:
            type: string
          description: Listed within N days.
        - name: availability
          in: query
          required: false
          schema:
            type: string
          description: e.g. available.
        - name: delivery_method
          in: query
          required: false
          schema:
            type: string
          description: e.g. local_pickup.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/photos:
    get:
      operationId: facebook_photos
      tags:
        - Facebook
      summary: Profile photos
      description: A profile's photos with captions and reaction counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/NASA
          description: Facebook profile or page URL.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/post:
    get:
      operationId: facebook_post
      tags:
        - Facebook
      summary: Post details
      description: "One Facebook post: text, reaction breakdown, comment and share counts. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/reel/2839681326387786/
          description: Full Facebook post URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/post-comments:
    get:
      operationId: facebook_post_comments
      tags:
        - Facebook
      summary: Post comments
      description: Comments on a Facebook post with reaction and reply counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/reel/2839681326387786/
          description: Full Facebook post URL.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/post-transcript:
    get:
      operationId: facebook_post_transcript
      tags:
        - Facebook
      summary: Video transcript
      description: The spoken words of a Facebook video or reel as text. transcript is null when the video has no speech or captions — that is the honest answer, not an error. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/reel/1114235920664408
          description: Facebook video post or reel URL, video under ~2 minutes.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/posts:
    get:
      operationId: facebook_posts
      tags:
        - Facebook
      summary: Page posts
      description: Recent posts on a Facebook page with reaction and comment counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/nasa
          description: Facebook page URL.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/profile:
    get:
      operationId: facebook_profile
      tags:
        - Facebook
      summary: Page profile
      description: "A Facebook page's public profile: category, contact details, follower and like counts. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/nasa
          description: Facebook page URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/facebook/profile/full:
    get:
      operationId: facebook_profile_full
      tags:
        - Facebook
      summary: Facebook profile with posts (one page)
      description: "A real public profile plus one page of posts/videos, preserving original normalized component fields and source order. HTTP 200 may be partial: inspect complete, partial and legs. Failed profile: no posts requested, zero charge. Failed posts: profile retained and only that successful component charged. Cached components use the public cache-hit price. Computed fields are transparent page arithmetic, not SocialCrawl metric-schema equivalence. Costs 2 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/mrbeast
          description: Public profile identifier. LinkedIn accepts /company/name or /in/name URLs.
        - name: posts
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Desired page size, 1-100. Existing components choose their own page size; the entire single source page is preserved, even if longer or shorter, so no records are skipped between cursors. No automatic extra pages.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque posts_cursor from the previous response; use posts_pagination.next_params to retain all required context. Unsupported component continuation is refused before calls.
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: posts,computed
          description: "CSV: posts and/or computed (default both), or profile alone. Profile is always returned. Computed is arithmetic over this page only, not an AI summary."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/facebook/reels:
    get:
      operationId: facebook_reels
      tags:
        - Facebook
      summary: Profile reels
      description: "A profile's reels: description, view count, duration, music and video URL per reel. Paged by cursor. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.facebook.com/pacemorby
          description: Facebook profile URL (personal profiles expose a reels tab; pages often do not).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/finance/history:
    get:
      operationId: finance_history
      tags:
        - Markets
      summary: Price history
      description: OHLCV bars for one instrument over a range at an interval. Costs 3 credits per successful live response.
      parameters:
        - name: symbol
          in: query
          required: true
          schema:
            type: string
          example: AAPL
          description: Ticker symbol
        - name: interval
          in: query
          required: false
          schema:
            type: string
          example: 1d
          description: 1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h, 1d, 5d, 1wk, 1mo or 3mo
        - name: range
          in: query
          required: false
          schema:
            type: string
          example: 1mo
          description: 1d, 5d, 7d, 15d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd or max
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/finance/news:
    get:
      operationId: finance_news
      tags:
        - Markets
      summary: Instrument news
      description: "Recent news articles about one instrument: title, publisher, link, time and related tickers. Costs 3 credits per successful live response."
      parameters:
        - name: symbol
          in: query
          required: true
          schema:
            type: string
          example: AAPL
          description: Ticker symbol
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/finance/options:
    get:
      operationId: finance_options
      tags:
        - Markets
      summary: Options chain
      description: "The nearest expiry's options chain for one instrument: calls and puts with strike, last, bid, ask, volume, open interest and implied volatility, plus the other expiries. Costs 3 credits per successful live response."
      parameters:
        - name: symbol
          in: query
          required: true
          schema:
            type: string
          example: AAPL
          description: Ticker symbol
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/finance/statements:
    get:
      operationId: finance_statements
      tags:
        - Markets
      summary: Company financial statements
      description: "Income statement, balance sheet or cash-flow statement of a listed company, one row per fiscal period: annual rows for each fiscal year, quarter-end rows with trailing-twelve-month figures, plus the latest trailing twelve months. Costs 3 credits per successful live response."
      parameters:
        - name: symbol
          in: query
          required: true
          schema:
            type: string
          example: AAPL
          description: Ticker symbol
        - name: statement
          in: query
          required: false
          schema:
            type: string
          example: income
          description: income, balance or cash
        - name: period
          in: query
          required: false
          schema:
            type: string
          example: all
          description: all, annual or quarterly
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/g2/category:
    get:
      operationId: g2_category
      tags:
        - G2
      summary: G2 category products
      description: The products in a G2 software category, with their typical user roles, industries and market segments. Re-wired 6 Sep 2026 on the platform's own page reader (migration 195) after the listing failed. Costs 2 credits per successful live response.
      parameters:
        - name: category
          in: query
          required: true
          schema:
            type: string
          example: marketing-automation
          description: Category slug or the full G2 category URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 15 products
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: g2-score
          description: g2-score, popularity or satisfaction
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/g2/category-links:
    get:
      operationId: g2_category_links
      tags:
        - G2
      summary: G2 category directory
      description: The directory of every software category on G2, 500 links per page. Costs 2 credits per successful live response.
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 500 category links
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/g2/product:
    get:
      operationId: g2_product
      tags:
        - G2
      summary: G2 product profile
      description: "A software product's G2 profile: rating, review count, pricing plans, feature scores, alternatives, comparisons, company details and public social profiles. Contact details are never included. Costs 1 credit per successful live response."
      parameters:
        - name: product
          in: query
          required: true
          schema:
            type: string
          example: postman
          description: Product slug or the full G2 product URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/g2/product-links:
    get:
      operationId: g2_product_links
      tags:
        - G2
      summary: G2 product directory
      description: The directory of every product profile on G2, 500 links per page, for crawling the catalogue end to end. Costs 2 credits per successful live response.
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 500 product links
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/g2/reviews:
    get:
      operationId: g2_reviews
      tags:
        - G2
      summary: G2 reviews
      description: Reviews of a software product, ten per page, with rating, text, date and the reviewer's role, company size and industry; filterable by stars, segment, industry, role, region and keywords. Costs 2 credits per successful live response.
      parameters:
        - name: product
          in: query
          required: true
          schema:
            type: string
          example: postman
          description: Product slug or the full G2 product URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 10 reviews; the response carries last_page and a cursor
        - name: stars
          in: query
          required: false
          schema:
            type: string
          example: 4,5
          description: Star ratings to include, comma-separated
        - name: segment
          in: query
          required: false
          schema:
            type: string
          example: mid-market
          description: small-business, mid-market or enterprise
        - name: industry
          in: query
          required: false
          schema:
            type: string
          example: "274"
          description: Industry ids from available_filters, comma-separated
        - name: role
          in: query
          required: false
          schema:
            type: string
          example: user
          description: Reviewer role names or ids, comma-separated
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: Europe
          description: Reviewer region, comma-separated
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: most-recent
          description: default, most-recent, most-helpful, highest-rated or lowest-rated
        - name: keywords
          in: query
          required: false
          schema:
            type: string
          example: api testing
          description: Only reviews mentioning this text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/g2/seller:
    get:
      operationId: g2_seller
      tags:
        - G2
      summary: G2 seller profile
      description: A software vendor's G2 seller profile with its product portfolio and cross-product review teasers. Re-wired 6 Sep 2026 on the platform's own page reader (migration 195) after the listing failed. Costs 1 credit per successful live response.
      parameters:
        - name: seller
          in: query
          required: true
          schema:
            type: string
          example: hubspot
          description: Seller slug or the full G2 seller URL
        - name: products_page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of the seller's products (9 per page)
        - name: reviews_page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of cross-product review teasers (3 per page, up to 10 pages)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/g2/seller-products:
    get:
      operationId: g2_seller_products
      tags:
        - G2
      summary: G2 seller products
      description: The products a software vendor lists on G2, nine per page, with ratings and review counts. Re-wired 6 Sep 2026 on the platform's own page reader (migration 195) after the listing failed. Costs 2 credits per successful live response.
      parameters:
        - name: seller
          in: query
          required: true
          schema:
            type: string
          example: google
          description: Seller slug or the full G2 seller URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 9 products
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/github/issue:
    get:
      operationId: github_issue
      tags:
        - GitHub
      summary: GitHub issue or pull request
      description: "One issue or pull request: title, state, labels, reactions and full body. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://github.com/vercel/next.js/issues/1
          description: Issue or pull request URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/issue/comments:
    get:
      operationId: github_issue_comments
      tags:
        - GitHub
      summary: GitHub issue comments
      description: Comments on an issue or pull request, oldest first. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://github.com/vercel/next.js/issues/1
          description: Issue or pull request URL
        - name: since
          in: query
          required: false
          schema:
            type: string
          example: "2026-01-01T00:00:00Z"
          description: Only comments updated at or after this ISO-8601 timestamp
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Opaque page cursor from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/profile:
    get:
      operationId: github_profile
      tags:
        - GitHub
      summary: GitHub user profile
      description: Public profile, follower counts and repository totals for a GitHub user. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: torvalds
          description: GitHub username
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/profile/repos:
    get:
      operationId: github_profile_repos
      tags:
        - GitHub
      summary: GitHub user repositories
      description: List a GitHub user's public repositories, most recently updated first. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: torvalds
          description: GitHub username
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: owner
          description: "Repository affiliation filter: all, owner or member"
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: updated
          description: "Sort key: created, updated, pushed or full_name (default updated)"
        - name: direction
          in: query
          required: false
          schema:
            type: string
          example: desc
          description: "Sort direction: asc or desc"
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Opaque page cursor from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/repo:
    get:
      operationId: github_repo
      tags:
        - GitHub
      summary: GitHub repository
      description: Stars, forks, issues and metadata for a public repository, addressed by URL or owner/repo. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://github.com/vercel/next.js
          description: Repository URL - or pass owner + repo instead
        - name: owner
          in: query
          required: false
          schema:
            type: string
          example: vercel
          description: Repository owner (used with repo when url is not given)
        - name: repo
          in: query
          required: false
          schema:
            type: string
          example: next.js
          description: Repository name (used with owner when url is not given)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/repo/dossier:
    get:
      operationId: github_repo_dossier
      tags:
        - GitHub
      summary: GitHub repository dossier
      description: "One-call project dossier: repo stats, README excerpt, latest releases, top issues and top contributors. Costs 5 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://github.com/vercel/next.js
          description: Repository URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/repo/issues:
    get:
      operationId: github_repo_issues
      tags:
        - GitHub
      summary: GitHub repository issues
      description: List a repository's issues (pull requests included, flagged per item). Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://github.com/vercel/next.js
          description: Repository URL
        - name: state
          in: query
          required: false
          schema:
            type: string
          example: open
          description: "Issue state: open, closed or all (default open)"
        - name: labels
          in: query
          required: false
          schema:
            type: string
          example: bug
          description: Comma-separated label names to filter by
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: issue
          description: "Client-side filter: issue or pr (GitHub's feed mixes both)"
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: created
          description: "Sort key: created, updated or comments"
        - name: direction
          in: query
          required: false
          schema:
            type: string
          example: desc
          description: "Sort direction: asc or desc"
        - name: since
          in: query
          required: false
          schema:
            type: string
          example: "2026-01-01T00:00:00Z"
          description: Only items updated at or after this ISO-8601 timestamp
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Opaque page cursor from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/repo/readme:
    get:
      operationId: github_repo_readme
      tags:
        - GitHub
      summary: GitHub repository README
      description: The repository's README decoded to markdown, with file metadata. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://github.com/vercel/next.js
          description: Repository URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/repo/releases:
    get:
      operationId: github_repo_releases
      tags:
        - GitHub
      summary: GitHub repository releases
      description: "Release history for a repository: tags, notes and downloadable assets. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://github.com/vercel/next.js
          description: Repository URL
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Opaque page cursor from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/repo/top-issues:
    get:
      operationId: github_repo_top_issues
      tags:
        - GitHub
      summary: GitHub repository top issues
      description: The most-reacted open feature request and the most-reacted open complaint for a repository. Costs 3 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://github.com/vercel/next.js
          description: Repository URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/search:
    get:
      operationId: github_search
      tags:
        - GitHub
      summary: GitHub issue search
      description: Search GitHub issues and pull requests with full advanced-search query syntax. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: repo:vercel/next.js is:issue is:open label:bug
          description: GitHub advanced search query, passed through verbatim
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: reactions
          description: Sort key, e.g. comments, reactions, created, updated
        - name: order
          in: query
          required: false
          schema:
            type: string
          example: desc
          description: "Sort direction: asc or desc"
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Opaque page cursor from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/github/user/profile-velocity:
    get:
      operationId: github_user_profile_velocity
      tags:
        - GitHub
      summary: GitHub user contribution velocity
      description: Weekly commit, PR, issue and review velocity for a user, computed from their recent public activity. Costs 5 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: torvalds
          description: GitHub username
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "3"
          description: Event pages to analyze, 1-3 (100 events per page, default 3)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google/search:
    get:
      operationId: google_search
      tags:
        - Google Quick Search
      summary: Web search
      description: "Google organic results for a query: position, title, URL and description. Paged by page number. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: best espresso machine
          description: Search term.
        - name: page
          in: query
          required: false
          schema:
            type: string
          description: Results page number, starting at 1.
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region code to search from.
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          description: Restrict by recency, e.g. past-week.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_ads/ad:
    get:
      operationId: google_ads_ad
      tags:
        - Google Ads Transparency
      summary: Ad details
      description: "One Google ad creative: impression band, regions shown, and the creative variations (headline, description, destination). Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://adstransparency.google.com/advertiser/AR02903092099014459393/creative/CR09470540953698697217
          description: adstransparency.google.com creative URL from google_ads/company-ads.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_ads/company-ads:
    get:
      operationId: google_ads_company_ads
      tags:
        - Google Ads Transparency
      summary: Company ads
      description: "Ads a company runs across Google surfaces: creative ids, formats and transparency-page links. Listing mode by design — drill into one ad with google_ads/ad. Paged by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: advertiser_id
          in: query
          required: true
          schema:
            type: string
          example: AR02903092099014459393
          description: Advertiser id from google_ads/search-advertisers (or pass domain instead).
        - name: domain
          in: query
          required: false
          schema:
            type: string
          example: lululemon.com
          description: Company domain — alternative to advertiser_id.
        - name: region
          in: query
          required: false
          schema:
            type: string
          description: Two-letter region code.
        - name: platform
          in: query
          required: false
          schema:
            type: string
          description: youtube, search, shopping, maps or play.
        - name: format
          in: query
          required: false
          schema:
            type: string
          description: text, image or video.
        - name: topic
          in: query
          required: false
          schema:
            type: string
          description: Topic filter.
        - name: start_date
          in: query
          required: false
          schema:
            type: string
          description: YYYY-MM-DD.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
          description: YYYY-MM-DD.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_ads/search-advertisers:
    get:
      operationId: google_ads_search_advertisers
      tags:
        - Google Ads Transparency
      summary: Advertiser search
      description: "Search Google Ads Transparency advertisers: verified advertiser ids, names and regions. The advertiser id feeds google_ads/company-ads. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: lululemon
          description: Advertiser or brand name.
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region code.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_finance/explore:
    get:
      operationId: google_finance_explore
      tags:
        - Google Finance
      summary: Google Finance explore
      description: The Google Finance explore board of notable movers. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: tech
          description: Optional theme
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_finance/markets:
    get:
      operationId: google_finance_markets
      tags:
        - Google Finance
      summary: Google Finance markets
      description: "A Google Finance market board: indexes, most active, gainers, losers, cryptocurrencies or currencies. Costs 4 credits per successful live response."
      parameters:
        - name: market
          in: query
          required: false
          schema:
            type: string
          example: indexes
          description: indexes, most_active, gainers, losers, climate_leaders, cryptocurrencies or currencies
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_finance/quote:
    get:
      operationId: google_finance_quote
      tags:
        - Google Finance
      summary: Google Finance quote
      description: "A quote from Google Finance: price, change, ranges, market cap and ratios. Costs 4 credits per successful live response."
      parameters:
        - name: ticker
          in: query
          required: true
          schema:
            type: string
          example: AAPL:NASDAQ
          description: Ticker with exchange
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_finance/ticker-search:
    get:
      operationId: google_finance_ticker_search
      tags:
        - Google Finance
      summary: Google Finance ticker search
      description: Tickers matching a query on Google Finance. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: nvidia
          description: Company or ticker text
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_news/search:
    get:
      operationId: google_news_search
      tags:
        - Google News
      summary: News search
      description: Worldwide news search with publisher, language, country and date filters. Costs 3 credits per successful live response.
      parameters:
        - name: keyword
          in: query
          required: true
          schema:
            type: string
          example: artificial intelligence
          description: Search phrase
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Number of articles to return (1-250)
        - name: language_code
          in: query
          required: false
          schema:
            type: string
          example: en
          description: ISO-639-1 language of the publisher
        - name: location_code
          in: query
          required: false
          schema:
            type: string
          example: us
          description: ISO-3166 country of the publisher
        - name: publisher
          in: query
          required: false
          schema:
            type: string
          example: bbc.co.uk
          description: Restrict to one publisher domain
        - name: time_range
          in: query
          required: false
          schema:
            type: string
          example: week
          description: hour, day, week or month
        - name: from
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-01"
          description: ISO-8601 start of an explicit window
        - name: to
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-31"
          description: ISO-8601 end of an explicit window
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_places/hotel:
    get:
      operationId: google_places_hotel
      tags:
        - Google Places
      summary: Google hotel
      description: One hotel on Google Hotels with prices by seller, amenities, rating and contact details. Costs 4 credits per successful live response.
      parameters:
        - name: hotel_id
          in: query
          required: true
          schema:
            type: string
          example: CgsIm7L7qpqJj-XlARAB
          description: Hotel identifier from a hotels search
        - name: check_in
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-10"
          description: Check-in date
        - name: check_out
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-12"
          description: Check-out date
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_places/hotels-search:
    get:
      operationId: google_places_hotels_search
      tags:
        - Google Places
      summary: Google Hotels search
      description: Hotels for a query on Google Hotels with price, stars, rating and amenities. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: hotels in Bath
          description: Search terms
        - name: check_in
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-10"
          description: Check-in date
        - name: check_out
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-12"
          description: Check-out date
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_places/listing:
    get:
      operationId: google_places_listing
      tags:
        - Google Places
      summary: Google business listing
      description: "A business's Google listing: categories, description, hours, attributes, rating, contact details and images. Costs 4 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Dishoom Shoreditch
          description: Business name, optionally with a place
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: London,England,United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_places/place:
    get:
      operationId: google_places_place
      tags:
        - Google Places
      summary: Place details
      description: "Full place record: contact details, opening hours, price level, rating and business status. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: ChIJl1wfOSCjdUgRhrFnqMsMhQM
          description: Google place id from a search result.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_places/questions:
    get:
      operationId: google_places_questions
      tags:
        - Google Places
      summary: Google business questions
      description: Questions asked on a business's Google listing with their answers. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Dishoom Shoreditch
          description: Business name, optionally with a place
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: London,England,United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Questions, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_places/reviews:
    get:
      operationId: google_places_reviews
      tags:
        - Google Places
      summary: Place reviews
      description: The most relevant reviews for a place (Google returns at most five; no pagination), with the place's overall rating. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: ChIJl1wfOSCjdUgRhrFnqMsMhQM
          description: Google place id from a search result.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_places/search:
    get:
      operationId: google_places_search
      tags:
        - Google Places
      summary: Place text search
      description: Search places and businesses by free text. Returns identity, address, coordinates, rating and links. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: coffee in Worthing
          description: "Free-text search: what and where."
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Results, 1–20 (default 10).
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_places/updates:
    get:
      operationId: google_places_updates
      tags:
        - Google Places
      summary: Google business updates
      description: Posts a business has published on its Google listing. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Dishoom Shoreditch
          description: Business name, optionally with a place
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: London,England,United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_play/app-info:
    get:
      operationId: google_play_app_info
      tags:
        - Google Play
      summary: Google Play app
      description: "One Google Play app by package name: title, developer, score, ratings and review counts, installs, price, version, release and update dates, rating histogram. Costs 1 credit per successful live response."
      parameters:
        - name: package
          in: query
          required: true
          schema:
            type: string
          example: co.uk.getmondo
          description: Play package name (or a Play Store URL)
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: gb
          description: 2-letter storefront country (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code (default en)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_play/app-list:
    get:
      operationId: google_play_app_list
      tags:
        - Google Play
      summary: Google Play top charts
      description: "A Google Play chart, ranked: top free, top paid or top grossing for a storefront, optionally within one category — rank, package name, title, developer, summary, score, price and icon for each entry. Costs 2 credits per successful live response."
      parameters:
        - name: collection
          in: query
          required: false
          schema:
            type: string
          example: top_free
          description: top_free (default), top_paid or top_grossing
        - name: category
          in: query
          required: false
          schema:
            type: string
          example: FINANCE
          description: "Play category id such as FINANCE, PRODUCTIVITY or GAME_PUZZLE (default: all apps)"
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: gb
          description: 2-letter storefront country (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code (default en)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Chart entries to return, 1-100 (default 50)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_play/app-reviews:
    get:
      operationId: google_play_app_reviews
      tags:
        - Google Play
      summary: Google Play app reviews
      description: "Reviews of a Google Play app, newest first by default: id, title, text, rating, author, date, version, helpful votes and the developer reply when there is one. Page with the returned cursor. Costs 2 credits per successful live response."
      parameters:
        - name: package
          in: query
          required: true
          schema:
            type: string
          example: co.uk.getmondo
          description: Play package name (or a Play Store URL)
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: gb
          description: 2-letter storefront country (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code (default en)
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: newest (default), helpful or rating
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Reviews per page, 1-100 (default 50)
        - name: rating
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Keep only reviews with this star rating (1-5), applied after the fetch
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_play/app-search:
    get:
      operationId: google_play_app_search
      tags:
        - Google Play
      summary: Google Play app search
      description: "Apps matching a term on Google Play: package name, title, developer, summary, score and price. Costs 2 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: budgeting
          description: Search term
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: gb
          description: 2-letter storefront country (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code (default en)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, 1-50 (default 20)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_play/categories:
    get:
      operationId: google_play_categories
      tags:
        - Google Play
      summary: Google Play categories
      description: The list of Google Play app categories. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_play/languages:
    get:
      operationId: google_play_languages
      tags:
        - Google Play
      summary: Google Play languages
      description: The list of Google Play store languages. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_play/locations:
    get:
      operationId: google_play_locations
      tags:
        - Google Play
      summary: Google Play locations
      description: The list of Google Play store locations. Free — costs 0 credits.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_play/search-suggestions:
    get:
      operationId: google_play_search_suggestions
      tags:
        - Google Play
      summary: Google Play search suggestions
      description: The search terms Google Play suggests for a partial query, in the order the store ranks them. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: spotify
          description: Partial search term
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: 2-letter storefront country code (default us)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code (default en)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_search/images:
    get:
      operationId: google_search_images
      tags:
        - Google Search
      summary: Google image search
      description: Image results for a query with the image and the page it appears on. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: aurora borealis
          description: Search terms
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_search/maps:
    get:
      operationId: google_search_maps
      tags:
        - Google Search
      summary: Google Maps search
      description: Places matching a query on Google Maps with rating, address, phone, website and coordinates. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: coffee near Shoreditch
          description: Search terms
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: London,England,United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_search/news:
    get:
      operationId: google_search_news
      tags:
        - Google Search
      summary: Google news search
      description: News results for a query with source, snippet and publication time. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: semiconductors
          description: Search terms
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_search/search:
    get:
      operationId: google_search_search
      tags:
        - Google Search
      summary: Google web search
      description: Organic web results for a query in a chosen location and language, with rank, domain, title and description. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: open source llm
          description: Search terms
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: London,England,United Kingdom
          description: Location name; defaults to the United Kingdom
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
        - name: device
          in: query
          required: false
          schema:
            type: string
          example: desktop
          description: desktop or mobile
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_shopping/deals:
    get:
      operationId: google_shopping_deals
      tags:
        - Google Shopping
      summary: Google Shopping deals
      description: Discounted products for a query on Google Shopping with sale and original price, discount and store. Costs 2 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: laptop
          description: Search terms
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Country name (default United Kingdom)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: "100"
          description: Lowest price
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: "900"
          description: Highest price
        - name: stores
          in: query
          required: false
          schema:
            type: string
          example: argos,currys
          description: Store names, comma-separated
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "40"
          description: Results, up to 120
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_shopping/price-history:
    get:
      operationId: google_shopping_price_history
      tags:
        - Google Shopping
      summary: Google Shopping price history
      description: Each store's price history for a Google Shopping product alongside its current price. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: catalogid:…
          description: Product id from google_shopping/search
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Country name (default United Kingdom)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 10 stores
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_shopping/product:
    get:
      operationId: google_shopping_product
      tags:
        - Google Shopping
      summary: Google Shopping product
      description: One Google Shopping product with its description, images, specification and rating. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1234567890123456789"
          description: Google Shopping product id from a search result
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_shopping/reviews:
    get:
      operationId: google_shopping_reviews
      tags:
        - Google Shopping
      summary: Google Shopping reviews
      description: Reviews of a Google Shopping product (keyed by the gid on a search card) with rating, text, date and reviewer name. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3896066944466806859"
          description: Google Shopping product gid (the gid on a google_shopping/search card)
        - name: docid
          in: query
          required: false
          schema:
            type: string
          example: "11901315168138976013"
          description: The card's docid, sent alongside for a precise match
        - name: product_id
          in: query
          required: false
          schema:
            type: string
          example: "4891805616949897996"
          description: The card's product id, sent alongside for a precise match
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_shopping/search:
    get:
      operationId: google_shopping_search
      tags:
        - Google Shopping
      summary: Google Shopping search
      description: Products for a query on Google Shopping with seller, price, currency and rating. Prepared as a queued task; a retry within fifteen minutes picks up the same result. Costs 5 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: noise cancelling headphones
          description: Search terms
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_shopping/sellers:
    get:
      operationId: google_shopping_sellers
      tags:
        - Google Shopping
      summary: Google Shopping sellers
      description: Every seller offering a Google Shopping product with price, shipping and total. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1234567890123456789"
          description: Google Shopping product id
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_shopping/store-reviews:
    get:
      operationId: google_shopping_store_reviews
      tags:
        - Google Shopping
      summary: Google Shopping store reviews
      description: Shopper reviews of an online store as shown on Google Shopping, with rating, text, author and date. Costs 2 credits per successful live response.
      parameters:
        - name: domain
          in: query
          required: true
          schema:
            type: string
          example: amazon.co.uk
          description: Store domain
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Country name (default United Kingdom)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Language code
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews, up to 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_trends/interest:
    get:
      operationId: google_trends_interest
      tags:
        - Google Trends
      summary: Google Trends interest
      description: Interest over time for up to five terms on Google Trends. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: electric bikes
          description: Up to five terms, comma-separated
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name; worldwide when empty
        - name: time_range
          in: query
          required: false
          schema:
            type: string
          example: past_12_months
          description: past_hour … past_5_years
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: web
          description: web, news, youtube, images or froogle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/google_trends/related:
    get:
      operationId: google_trends_related
      tags:
        - Google Trends
      summary: Google Trends related
      description: Related queries and topics, top and rising, for a term on Google Trends. Costs 4 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: electric bikes
          description: One term
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: United Kingdom
          description: Location name; worldwide when empty
        - name: time_range
          in: query
          required: false
          schema:
            type: string
          example: past_12_months
          description: past_hour … past_5_years
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: web
          description: web, news, youtube, images or froogle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/categories:
    get:
      operationId: gumtree_categories
      tags:
        - Gumtree
      summary: Gumtree categories
      description: The category tree, or one category's subtree. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: "9311"
          description: Category id to return a subtree; omit for the whole tree
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/filters:
    get:
      operationId: gumtree_filters
      tags:
        - Gumtree
      summary: Gumtree category filters
      description: The filters a category offers, with their kinds, parameters and options. Costs 1 credit per successful live response.
      parameters:
        - name: category
          in: query
          required: true
          schema:
            type: string
          example: "9311"
          description: Category id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/locations:
    get:
      operationId: gumtree_locations
      tags:
        - Gumtree
      summary: Gumtree location lookup
      description: Location ids for a place name, with coordinates, for use in searches. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: london
          description: Place name, outcode or postcode
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: location, outcode or postcode
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/locations-nearest:
    get:
      operationId: gumtree_locations_nearest
      tags:
        - Gumtree
      summary: Gumtree nearest location
      description: The site's location record nearest to a coordinate. Costs 1 credit per successful live response.
      parameters:
        - name: latitude
          in: query
          required: true
          schema:
            type: string
          example: "51.5074"
          description: Latitude
        - name: longitude
          in: query
          required: true
          schema:
            type: string
          example: "-0.1278"
          description: Longitude
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/product:
    get:
      operationId: gumtree_product
      tags:
        - Gumtree
      summary: Gumtree listing
      description: "One listing's page: description, price, category path, location, attributes, images, the seller's profile and the seller ids the seller routes take. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1513645531"
          description: Ad id (or pass url, the listing's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The listing's page URL instead of an id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/product-similar:
    get:
      operationId: gumtree_product_similar
      tags:
        - Gumtree
      summary: Gumtree similar listings
      description: Listings similar to one listing. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1513645531"
          description: Ad id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/search:
    get:
      operationId: gumtree_search
      tags:
        - Gumtree
      summary: Gumtree search
      description: "One page of Gumtree UK listings for a keyword: title, price, location, age, seller flags and URL. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: laptop
          description: Search keyword
        - name: category
          in: query
          required: false
          schema:
            type: string
          example: laptops
          description: Category slug
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: london
          description: Location slug
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/search-suggestions:
    get:
      operationId: gumtree_search_suggestions
      tags:
        - Gumtree
      summary: Gumtree search suggestions
      description: Keyword suggestions for a partial search, each with the category it belongs to. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: iph
          description: Partial keyword
        - name: category
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Category id to scope the suggestions
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/seller:
    get:
      operationId: gumtree_seller
      tags:
        - Gumtree
      summary: Gumtree seller
      description: "A seller's public profile: name, rating, membership, activity and verification flags. Costs 2 credits per successful live response."
      parameters:
        - name: user_id
          in: query
          required: true
          schema:
            type: string
          example: "102166807"
          description: Seller user id, from gumtree/product's seller block
        - name: public_user_id
          in: query
          required: true
          schema:
            type: string
          example: fa9ac182800e5bfe6a43e4540ea92fcb
          description: Seller public id, from the same block
        - name: account_id
          in: query
          required: false
          schema:
            type: string
          example: "101624600"
          description: Seller account id, from the same block
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/seller-listings:
    get:
      operationId: gumtree_seller_listings
      tags:
        - Gumtree
      summary: Gumtree seller listings
      description: A seller's active listings, twenty a page. Costs 3 credits per successful live response.
      parameters:
        - name: user_id
          in: query
          required: true
          schema:
            type: string
          example: "102166807"
          description: Seller user id
        - name: public_user_id
          in: query
          required: true
          schema:
            type: string
          example: fa9ac182800e5bfe6a43e4540ea92fcb
          description: Seller public id
        - name: account_id
          in: query
          required: false
          schema:
            type: string
          example: "101624600"
          description: Seller account id
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/gumtree/trending:
    get:
      operationId: gumtree_trending
      tags:
        - Gumtree
      summary: Gumtree trending searches
      description: The search terms trending on the site right now. Costs 1 credit per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hackernews/profile:
    get:
      operationId: hackernews_profile
      tags:
        - Hacker News
      summary: Hacker News profile
      description: Karma, join date, about text and submission count for a Hacker News account, merged from the official Firebase API and the Algolia index. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: pg
          description: Hacker News username
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hackernews/search:
    get:
      operationId: hackernews_search
      tags:
        - Hacker News
      summary: Hacker News search
      description: Full-text search over Hacker News stories and comments with tag and numeric filters, via the Algolia HN index. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: dropbox
          description: Full-text search query
        - name: tags
          in: query
          required: false
          schema:
            type: string
          example: story
          description: "Algolia tag filter: story, comment, poll, show_hn, ask_hn, front_page, author_USERNAME, story_ID. Comma-separated tags AND together; parentheses OR."
        - name: numericFilters
          in: query
          required: false
          schema:
            type: string
          example: points>100
          description: Comma-separated numeric conditions on points, num_comments or created_at_i
        - name: hitsPerPage
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Results per page, 1-100 (default 25)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "0"
          description: Zero-based page number
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Pagination cursor from a previous response; equivalent to page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hackernews/story:
    get:
      operationId: hackernews_story
      tags:
        - Hacker News
      summary: Hacker News story
      description: A Hacker News story with score, author, text and an exact comment count in one call. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "8863"
          description: Numeric Hacker News item id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hackernews/story/comments:
    get:
      operationId: hackernews_story_comments
      tags:
        - Hacker News
      summary: Hacker News story comments
      description: The full comment tree of a Hacker News story in one call, flattened with depth and parent ids (up to 500 comments). Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "8863"
          description: Numeric Hacker News story id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/categories:
    get:
      operationId: hm_categories
      tags:
        - H&M
      summary: H&M categories
      description: The category tree of an H&M storefront. Costs 1 credit per successful live response.
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Storefront code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/countries:
    get:
      operationId: hm_countries
      tags:
        - H&M
      summary: H&M storefronts
      description: The retailer's country and language list, by region, with each country's storefront language links. Costs 1 credit per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/new-arrivals:
    get:
      operationId: hm_new_arrivals
      tags:
        - H&M
      summary: H&M new arrivals
      description: The newest products on an H&M storefront. Costs 2 credits per successful live response.
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Storefront code
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "22"
          description: Per page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/product:
    get:
      operationId: hm_product
      tags:
        - H&M
      summary: H&M product
      description: "One H&M product: title, price, description, composition, care, colours and variants. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1258254001"
          description: Article code (the number in the product URL)
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Storefront code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/product-suppliers:
    get:
      operationId: hm_product_suppliers
      tags:
        - H&M
      summary: H&M product suppliers
      description: "The supplier and factory record the retailer publishes for a product: country, supplier and each factory's name, address and workforce band. Costs 2 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1303341009"
          description: Product id, the digits in the product page URL
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Language code such as en_us
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/search:
    get:
      operationId: hm_search
      tags:
        - H&M
      summary: H&M product search
      description: Products matching a keyword on an H&M storefront, with price, colours and images. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: jacket
          description: Search keyword
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Storefront code from hm/countries
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "36"
          description: Per page, up to 60
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/similar:
    get:
      operationId: hm_similar
      tags:
        - H&M
      summary: H&M similar products
      description: Products similar to one product. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1258254001"
          description: Article code
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Storefront code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/stores:
    get:
      operationId: hm_stores
      tags:
        - H&M
      summary: H&M stores
      description: "Every store in a country: address, coordinates, opening hours, departments and status. Costs 1 credit per successful live response."
      parameters:
        - name: country
          in: query
          required: true
          schema:
            type: string
          example: us
          description: Two-letter country code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Language code such as en_us
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/hm/suggestions:
    get:
      operationId: hm_suggestions
      tags:
        - H&M
      summary: H&M search suggestions
      description: Search suggestions for a partial query. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: jack
          description: Partial search text
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: en_us
          description: Storefront code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/home_depot/product:
    get:
      operationId: home_depot_product
      tags:
        - Home Depot
      summary: Home Depot product
      description: "One Home Depot product: title, brand, model and UPC, price and any promotion, rating and review count, availability, description, highlights, specifications by group, images and videos, category path. Costs 1 credit per successful live response."
      parameters:
        - name: item_id
          in: query
          required: false
          schema:
            type: string
          example: "203203319"
          description: The item id, the number at the end of a homedepot.com product URL. Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.homedepot.com/p/Krud-Kutter-32-oz-Brush-Wash-and-Renewer-BW326/203203319
          description: Product page URL
        - name: store_id
          in: query
          required: false
          schema:
            type: string
          example: "1087"
          description: Store number to localise price and availability; store 1087 stands in when omitted (store_defaulted says so)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/home_depot/reviews:
    get:
      operationId: home_depot_reviews
      tags:
        - Home Depot
      summary: Home Depot product reviews
      description: Reviews of a Home Depot product with rating, author, photos and store responses. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "204279858"
          description: Home Depot item id (the number at the end of its product URL), or the URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: newest, oldest, helpful, highest, lowest or photos
        - name: rating
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only this star rating
        - name: verified
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: 1 for verified purchases only
        - name: keywords
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only reviews mentioning this text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/home_depot/search:
    get:
      operationId: home_depot_search
      tags:
        - Home Depot
      summary: Home Depot search
      description: "Search the Home Depot catalogue: product cards with id, title, brand, model number, price (current, was, saving), rating and review count, badges, thumbnails, delivery and pickup, with the page's filters, total and a cursor to the next page (up to 30 pages). Reactivated 6 Sep 2026 on a search-results supplier after the marketplace listing failed (188). Costs 2 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: cordless drill
          description: Search words
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number, 1 to 30 (24 products per page)
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: top_sellers
          description: best_match (default), top_sellers, top_rated, price_low_to_high or price_high_to_low
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Lowest price to include, in dollars
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: "150"
          description: Highest price to include, in dollars
        - name: store_id
          in: query
          required: false
          schema:
            type: string
          example: "1087"
          description: Store number to localise price and availability
        - name: delivery_zip
          in: query
          required: false
          schema:
            type: string
          example: "10001"
          description: ZIP code for delivery availability
        - name: free_ship_to_store
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Only products with free ship-to-store
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/instagram/about:
    get:
      operationId: instagram_about
      tags:
        - Instagram
      summary: Instagram account transparency panel
      description: "The \"About this account\" panel of a public account: country, month joined, verification and its date, and the counts of former usernames and of accounts with shared followers, each null when the platform shows nothing. A handle is resolved to the account id first (reported as lookup). Restored 6 September 2026 through the direct photo-network supplier. Costs 3 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram username or profile URL
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: "The numeric account id, if already known: skips the lookup request"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/instagram/audio-reels:
    get:
      operationId: instagram_audio_reels
      tags:
        - Instagram
      summary: Reels using an audio
      description: Reels that use a specific audio track — sound-trend intelligence for Instagram. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: audio_id
          in: query
          required: true
          schema:
            type: string
          example: "1392969992841787"
          description: Instagram audio id.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/basic-profile:
    get:
      operationId: instagram_basic_profile
      tags:
        - Instagram
      summary: Instagram profile by id
      description: A profile looked up by its numeric id — the id comments and tags carry — in the same shape as the profile route. Costs 1 credit per successful live response.
      parameters:
        - name: user_id
          in: query
          required: true
          schema:
            type: string
          example: "528817151"
          description: Numeric Instagram user id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/comment-replies:
    get:
      operationId: instagram_comment_replies
      tags:
        - Instagram
      summary: Comment replies
      description: The reply thread under one Instagram comment. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.instagram.com/reel/C8rKmYvsrck
          description: Full Instagram post/reel URL.
        - name: comment_id
          in: query
          required: true
          schema:
            type: string
          example: "18038110327814211"
          description: Comment id from instagram/post-comments.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/highlight:
    get:
      operationId: instagram_highlight
      tags:
        - Instagram
      summary: Highlight items
      description: Every item inside one story highlight, as normalized media. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "18195781759377100"
          description: Highlight id from instagram/highlights.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/highlights:
    get:
      operationId: instagram_highlights
      tags:
        - Instagram
      summary: Profile highlights
      description: "An account's story highlights: id, title and cover. The id feeds instagram/highlight. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram username (or pass user_id).
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          description: Numeric user id — alternative to handle.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/location-posts:
    get:
      operationId: instagram_location_posts
      tags:
        - Instagram
      summary: Instagram location posts
      description: Posts tagged at a place, most recent or top-ranked, with captions, counts and authors; paged by cursor. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "212988663"
          description: Numeric location id — the number in an Instagram place page URL (instagram.com/explore/locations/<id>/…)
        - name: tab
          in: query
          required: false
          schema:
            type: string
          example: recent
          description: recent (chronological, default) or top (ranked)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/music-trending:
    get:
      operationId: instagram_music_trending
      tags:
        - Instagram
      summary: Instagram trending music
      description: The audio tracks trending in Reels right now, ranked, with the Reels count label, the previous rank and the public 30-second preview link. Served from 6 September 2026 by the fourth Instagram listing (Ultra plan). Costs 2 credits per successful live response.
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/instagram/post:
    get:
      operationId: instagram_post
      tags:
        - Instagram
      summary: Post details
      description: "One Instagram post or reel: caption, media URLs, author and current counts. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.instagram.com/p/B9KI0D2HHe7/
          description: Instagram post or reel URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/post-comments:
    get:
      operationId: instagram_post_comments
      tags:
        - Instagram
      summary: Post comments
      description: Comments on an Instagram post with like and reply counts. Paged by cursor. With sort=top or sort=recent the order is the platform's own, through the direct supplier. Costs 3 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.instagram.com/p/B9KI0D2HHe7/
          description: Instagram post or reel URL.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: recent
          description: top (the platform's popular order) or recent (newest first); omitted = the answering source's own order. Send a cursor back with the sort it came with.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/post-count:
    get:
      operationId: instagram_post_count
      tags:
        - Instagram
      summary: Instagram post count
      description: How many posts an Instagram profile has published. Costs 3 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/post-likers:
    get:
      operationId: instagram_post_likers
      tags:
        - Instagram
      summary: Instagram post likers
      description: A ranked sample of the accounts that liked a post or reel (handle, name, verification, privacy, avatar), with the post's like count as total. One sample per post; the platform exposes no further pages. Restored 6 September 2026 through the fourth Instagram listing. Costs 2 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.instagram.com/p/B9KI0D2HHe7/
          description: Post or reel URL, or its shortcode
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/instagram/post-transcript:
    get:
      operationId: instagram_post_transcript
      tags:
        - Instagram
      summary: Reel transcript
      description: The spoken words of an Instagram reel as text. A photo post answers 404 — there is nothing to transcribe. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.instagram.com/reel/DcuQVFLvJMX/
          description: Instagram reel URL (must be a video).
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/posts:
    get:
      operationId: instagram_posts
      tags:
        - Instagram
      summary: Profile posts
      description: Recent posts for an Instagram account with engagement counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram username.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/profile:
    get:
      operationId: instagram_profile
      tags:
        - Instagram
      summary: Instagram profile
      description: "Public Instagram profile: identity, bio, follower/following/post counts. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram username, with or without the leading @.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/profile-followers:
    get:
      operationId: instagram_profile_followers
      tags:
        - Instagram
      summary: Instagram followers
      description: Accounts following a public account, fifty per page with handle, name, verification and privacy flags; paged by offset. Costs 2 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram username, with or without the leading @
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Accounts per page, at most 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Offset from the previous page
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only accounts whose name or handle contains this text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/profile-following:
    get:
      operationId: instagram_profile_following
      tags:
        - Instagram
      summary: Instagram following
      description: Accounts a public account follows, fifty per page with handle, name, verification and privacy flags; paged by offset. Costs 2 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram username, with or without the leading @
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Accounts per page, at most 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Offset from the previous page
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only accounts whose name or handle contains this text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/profile/full:
    get:
      operationId: instagram_profile_full
      tags:
        - Instagram
      summary: Instagram profile with posts (one page)
      description: "A real public profile plus one page of posts/videos, preserving original normalized component fields and source order. HTTP 200 may be partial: inspect complete, partial and legs. Failed profile: no posts requested, zero charge. Failed posts: profile retained and only that successful component charged. Cached components use the public cache-hit price. Computed fields are transparent page arithmetic, not SocialCrawl metric-schema equivalence. Costs 2 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: mrbeast
          description: Public profile identifier. LinkedIn accepts /company/name or /in/name URLs.
        - name: posts
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Desired page size, 1-100. Existing components choose their own page size; the entire single source page is preserved, even if longer or shorter, so no records are skipped between cursors. No automatic extra pages.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque posts_cursor from the previous response; use posts_pagination.next_params to retain all required context. Unsupported component continuation is refused before calls.
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: posts,computed
          description: "CSV: posts and/or computed (default both), or profile alone. Profile is always returned. Computed is arithmetic over this page only, not an AI summary."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/instagram/reels:
    get:
      operationId: instagram_reels
      tags:
        - Instagram
      summary: Profile reels
      description: Recent reels for an Instagram account with play counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram username.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/reels-trending:
    get:
      operationId: instagram_reels_trending
      tags:
        - Instagram
      summary: Trending reels
      description: A batch of currently-trending reels from Instagram's public reels surface. Small batches that can overlap — call repeatedly for more. Costs 3 credits per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/reposts:
    get:
      operationId: instagram_reposts
      tags:
        - Instagram
      summary: Instagram reposts
      description: Posts an account has reposted to its own feed from other accounts, with captions, counts and original authors; paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: nasa
          description: Instagram username (or pass user_id)
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          example: "528817151"
          description: Numeric account id — alternative to handle
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/search:
    get:
      operationId: instagram_search
      tags:
        - Instagram
      summary: Post search
      description: Popular Instagram posts and reels for a search term, with captions, play counts and authors. Niche phrases with no curated page return NOT_FOUND unchanged — that response is free. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: nike
          description: Search term. Works best for topics Instagram curates a popular page for (brands, subjects, places).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/search-hashtag:
    get:
      operationId: instagram_search_hashtag
      tags:
        - Instagram
      summary: Hashtag search
      description: Posts under an Instagram hashtag with captions, URLs and authors. Paged by cursor. Costs 3 credits per successful live response.
      parameters:
        - name: hashtag
          in: query
          required: true
          schema:
            type: string
          example: makeup
          description: "Hashtag without the #."
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          description: Restrict by post date, e.g. last-week.
        - name: media_type
          in: query
          required: false
          schema:
            type: string
          description: all, photo or video.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/search-locations:
    get:
      operationId: instagram_search_locations
      tags:
        - Instagram
      summary: Instagram location search
      description: "Instagram places matching a name: the location id, address, city and coordinates, as Instagram's own place search suggests them. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Louvre
          description: A place name
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Places to return, up to 50
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/search-music:
    get:
      operationId: instagram_search_music
      tags:
        - Instagram
      summary: Instagram music search
      description: "Instagram audio tracks matching a keyword: title, artist, duration, the Reels count label, trending rank and the public 30-second preview link. Served from 6 September 2026 by the fourth Instagram listing (Ultra plan). Costs 2 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: espresso
          description: "Keyword: a title, an artist or a lyric fragment"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/instagram/search-profiles:
    get:
      operationId: instagram_search_profiles
      tags:
        - Instagram
      summary: Profile search
      description: Search Instagram accounts by keyword, with follower counts inline. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Search term.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/search-reels:
    get:
      operationId: instagram_search_reels
      tags:
        - Instagram
      summary: Reels search
      description: "Search Instagram reels by keyword: caption, URL, author and engagement. Paged by page-number cursor. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: dogs
          description: What to search for.
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          description: Restrict by post date, e.g. last-week.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Page number, starting at 1.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/search-top:
    get:
      operationId: instagram_search_top
      tags:
        - Instagram
      summary: Native search
      description: "Instagram's own ranked search: accounts, hashtags, places and keyword suggestions in one response. Single page by design. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: nike
          description: What to search for.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/similar-accounts:
    get:
      operationId: instagram_similar_accounts
      tags:
        - Instagram
      summary: Instagram similar accounts
      description: Accounts the platform surfaces as similar to a given account (its suggested follows). Large verified accounts may surface none. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: nasa
          description: Instagram username (or pass user_id)
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          example: "528817151"
          description: Numeric account id — alternative to handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/stories:
    get:
      operationId: instagram_stories
      tags:
        - Instagram
      summary: Instagram stories
      description: "A public account's stories live right now: media URLs, posting and expiry times, mentions, hashtags, link and music stickers. Empty when nothing is live. Costs 2 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Instagram username, with or without the leading @
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/instagram/story:
    get:
      operationId: instagram_story
      tags:
        - Instagram
      summary: Instagram story
      description: "One Instagram story by id while it is live: media links at every size, whether it is a video, when it was taken, the author and the caption. Stories expire after a day; an expired one is a 404. Costs 2 credits per successful live response."
      parameters:
        - name: story_id
          in: query
          required: true
          schema:
            type: string
          example: "3979517011039436364"
          description: The story id from instagram/stories (with or without the _userid suffix)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/instagram/tagged-posts:
    get:
      operationId: instagram_tagged_posts
      tags:
        - Instagram
      summary: Instagram tagged posts
      description: Posts a user has been tagged in, one page at a time, with codes, captions, counts and the posting author. Costs 1 credit per successful live response.
      parameters:
        - name: user_id
          in: query
          required: true
          schema:
            type: string
          example: "528817151"
          description: Numeric Instagram user id
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/bing/job:
    get:
      operationId: jobs_bing_job
      tags:
        - Job boards
      summary: Bing job posting
      description: One aggregated job posting from Bing with its description and apply link. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: OJA.1654796514
          description: Job id from a search result
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/bing/search:
    get:
      operationId: jobs_bing_search
      tags:
        - Job boards
      summary: Bing job search
      description: Search Bing's aggregated job postings by location and keywords. Costs 3 credits per successful live response.
      parameters:
        - name: location
          in: query
          required: true
          schema:
            type: string
          example: Switzerland
          description: Country or city
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: java
          description: Keywords, title, company or position
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          example: week
          description: week or day
        - name: employment_types
          in: query
          required: false
          schema:
            type: string
          example: fulltime
          description: contractor, fulltime, parttime or temporary
        - name: remote_only
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: true to keep remote roles only
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/indeed/job:
    get:
      operationId: jobs_indeed_job
      tags:
        - Job boards
      summary: Indeed job posting
      description: One Indeed job posting with its description, employer and apply link. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: a1b2c3d4e5f6a7b8
          description: Job id from a search result
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/indeed/search:
    get:
      operationId: jobs_indeed_search
      tags:
        - Job boards
      summary: Indeed job search
      description: Search Indeed job postings in a country by keywords, location and radius. Costs 3 credits per successful live response.
      parameters:
        - name: country_code
          in: query
          required: true
          schema:
            type: string
          example: gb
          description: Two-letter country code
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: nurse
          description: Keywords, title, company or position
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Manchester
          description: City, town or province
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: date
          description: relevance or date
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Search radius
        - name: radius_unit
          in: query
          required: false
          schema:
            type: string
          example: km
          description: km or miles
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/linkedin/job:
    get:
      operationId: jobs_linkedin_job
      tags:
        - Job boards
      summary: LinkedIn job posting
      description: One LinkedIn job posting with its description, seniority, function, industries and applicant count. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4344456572"
          description: Job id from a search result
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/linkedin/organizations:
    get:
      operationId: jobs_linkedin_organizations
      tags:
        - Job boards
      summary: LinkedIn organisation lookup
      description: Organisation ids for a name, to filter LinkedIn job searches by employer. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: google
          description: Organisation or school name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/linkedin/search:
    get:
      operationId: jobs_linkedin_search
      tags:
        - Job boards
      summary: LinkedIn job search
      description: Search LinkedIn job postings by keywords, location, organisation, date, employment type, experience level and workplace type. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: data engineer
          description: Keywords, title, company or position
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: London
          description: Country or city; worldwide when empty
        - name: organization_ids
          in: query
          required: false
          schema:
            type: string
          example: "1441"
          description: Organisation ids from jobs/linkedin/organizations, semicolon-separated
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          example: week
          description: month, week or day
        - name: employment_types
          in: query
          required: false
          schema:
            type: string
          example: fulltime;parttime
          description: contractor, fulltime, parttime, intern or temporary
        - name: experience_levels
          in: query
          required: false
          schema:
            type: string
          example: midSenior
          description: intern, entry, associate, midSenior or director
        - name: workplace_types
          in: query
          required: false
          schema:
            type: string
          example: remote
          description: remote, hybrid or onSite
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/salary/range:
    get:
      operationId: jobs_salary_range
      tags:
        - Job boards
      summary: Salary range
      description: Yearly, monthly, weekly, daily and hourly salary bands (min, max, mean, median) for a job title in a country. Costs 2 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: developer
          description: A job title from jobs/salary/titles
        - name: country_code
          in: query
          required: false
          schema:
            type: string
          example: us
          description: Two-letter country code (default us)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/salary/titles:
    get:
      operationId: jobs_salary_titles
      tags:
        - Job boards
      summary: Salary job titles
      description: Canonical job titles matching a query, to feed the salary range route. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: programming
          description: Free text to match job titles
        - name: country_code
          in: query
          required: false
          schema:
            type: string
          example: us
          description: Two-letter country code (default us)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/xing/job:
    get:
      operationId: jobs_xing_job
      tags:
        - Job boards
      summary: Xing job posting
      description: One Xing job posting with its salary band, benefits, skills and responsibilities. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "12345678"
          description: Job id from a search result
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/jobs/xing/search:
    get:
      operationId: jobs_xing_search
      tags:
        - Job boards
      summary: Xing job search
      description: Search Xing job postings (the German-speaking market) by keywords, location, level, remote options and salary. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Java
          description: Keywords, title, company or position
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Schweiz
          description: Location, written in German
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          example: week
          description: week, day or month
        - name: employment_types
          in: query
          required: false
          schema:
            type: string
          example: fulltime
          description: contractor, fulltime, intern, parttime, seasonal, temporary or voluntary
        - name: career_levels
          in: query
          required: false
          schema:
            type: string
          example: professional
          description: student, entry, professional, manager, executive or seniorExecutive
        - name: remote_options
          in: query
          required: false
          schema:
            type: string
          example: remote
          description: remote, hybrid or onSite
        - name: minimum_salary
          in: query
          required: false
          schema:
            type: string
          example: "60000"
          description: Minimum annual salary
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kick/clip:
    get:
      operationId: kick_clip
      tags:
        - Kick
      summary: Kick clip
      description: "One clip: title, video and thumbnail URLs, duration, views, likes, times, category, creator and channel. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://kick.com/xqc/clips/clip_01JGJHB6CEVFCQRYTVPM8DW892
          description: Clip URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/categories:
    get:
      operationId: klarna_categories
      tags:
        - Klarna
      summary: Klarna categories
      description: The top-level category tree with each department's children. Costs 1 credit per successful live response.
      parameters:
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/categories-children:
    get:
      operationId: klarna_categories_children
      tags:
        - Klarna
      summary: Klarna sub-categories
      description: The children of one category, with their images and their own children. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: t1
          description: Category id, e.g. t1
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/category:
    get:
      operationId: klarna_category
      tags:
        - Klarna
      summary: Klarna category products
      description: Products in a category, sorted and filtered, with the sub-categories and brands the page offers. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: cl94
          description: Category id, e.g. cl94
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: popularity
          description: popularity, price_asc, price_desc, trend, name, rating or price_drop
        - name: price_range
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Price band such as 50-500
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "48"
          description: Products per page, at most 48
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Offset from the previous page
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/category-filters:
    get:
      operationId: klarna_category_filters
      tags:
        - Klarna
      summary: Klarna category filters
      description: The filters a category page offers, grouped, with their types and units. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: cl94
          description: Category id
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/category-guide:
    get:
      operationId: klarna_category_guide
      tags:
        - Klarna
      summary: Klarna category buying guide
      description: "The buying guide of a category: frequently asked questions and shopping tips. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: cl94
          description: Category id
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/category-keywords:
    get:
      operationId: klarna_category_keywords
      tags:
        - Klarna
      summary: Klarna category keywords
      description: The popular search keywords of a category. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: t1
          description: Category id
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/compare:
    get:
      operationId: klarna_compare
      tags:
        - Klarna
      summary: Klarna product comparison
      description: "Two products side by side: prices, ratings and the category's attribute groups. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3331931645"
          description: First product id
        - name: id2
          in: query
          required: true
          schema:
            type: string
          example: "3216399795"
          description: Second product id
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/price-history:
    get:
      operationId: klarna_price_history
      tags:
        - Klarna
      summary: Klarna price history
      description: The price of a product over time, per retailer offer, with the lowest and highest seen. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3216399795"
          description: Product id
        - name: interval
          in: query
          required: false
          schema:
            type: string
          example: three_months
          description: one_month, three_months or all
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/product:
    get:
      operationId: klarna_product
      tags:
        - Klarna
      summary: Klarna product
      description: "One product page: description and article, brand, category and breadcrumbs, rating, rank in its category, retailer count, cheapest instalment and the full specification table. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3216399795"
          description: Product id, as returned by search
        - name: category
          in: query
          required: true
          schema:
            type: string
          example: cl94
          description: The product's category id, as returned by search
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/product-offers:
    get:
      operationId: klarna_product_offers
      tags:
        - Klarna
      summary: Klarna product offers
      description: "Every retailer's offer for one product: price, stock, shipping, instalment terms and the retailer's outbound link, plus the product's images. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3216399795"
          description: Product id
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/reviews:
    get:
      operationId: klarna_reviews
      tags:
        - Klarna
      summary: Klarna product reviews
      description: "Shopper reviews of a product gathered from retailers' sites: rating, text, source, author, date, pros and cons. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3207919327"
          description: Product id
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Reviews per page, at most 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/reviews-overview:
    get:
      operationId: klarna_reviews_overview
      tags:
        - Klarna
      summary: Klarna reviews overview
      description: "The rating summary of a product: overall score, counts, score distributions for shoppers and experts, and the first reviews of each kind. Costs 2 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3207919327"
          description: Product id
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Shopper reviews to include, at most 50
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/reviews-pro:
    get:
      operationId: klarna_reviews_pro
      tags:
        - Klarna
      summary: Klarna professional reviews
      description: "Expert reviews of a product from the press: rating, verdict, source, date, pros and cons. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3207919327"
          description: Product id
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Reviews per page, at most 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/search:
    get:
      operationId: klarna_search
      tags:
        - Klarna
      summary: Klarna product search
      description: "Products matching a keyword across every retailer in the catalogue: lowest price, rating, rank, category, cheapest offer and instalment terms. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: headphone
          description: Search keyword
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: "Catalogue region: usa, uk, germany, france, italy, spain, netherlands, sweden, norway, denmark, finland, austria, ireland, poland, belgium"
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "48"
          description: Products per page, at most 48
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Offset from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/search-suggestions:
    get:
      operationId: klarna_search_suggestions
      tags:
        - Klarna
      summary: Klarna search suggestions
      description: Suggested categories and brands for a partial keyword, with the first matching products. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: headphone
          description: Partial keyword
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/store-filters:
    get:
      operationId: klarna_store_filters
      tags:
        - Klarna
      summary: Klarna store filters
      description: "The filters a store page offers: price range, categories, brands and retailers with counts. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: 09f4d635-0452-4f63-9455-c45420d95669
          description: Store id, from klarna/stores
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/store-products:
    get:
      operationId: klarna_store_products
      tags:
        - Klarna
      summary: Klarna store products
      description: Products sold by one partner store, sorted and paged. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: 09f4d635-0452-4f63-9455-c45420d95669
          description: Store id, from klarna/stores
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: popularity
          description: popularity, price_asc, price_desc, trend, name, rating or price_drop
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Products per page, at most 25
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Offset from the previous page
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/klarna/stores:
    get:
      operationId: klarna_stores
      tags:
        - Klarna
      summary: Klarna partner stores
      description: "The partner-store directory: name, category, delivery time and cost, payment options and logos. Costs 1 credit per successful live response."
      parameters:
        - name: category
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Store category filter, e.g. travel
        - name: cashback
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: true to keep stores with cashback
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "24"
          description: Stores per page, at most 24
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Offset from the previous page
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: usa
          description: Catalogue region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kohls/categories:
    get:
      operationId: kohls_categories
      tags:
        - Kohl's
      summary: Kohl's categories
      description: The category tree of the store. Costs 1 credit per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kohls/questions:
    get:
      operationId: kohls_questions
      tags:
        - Kohl's
      summary: Kohl's product questions
      description: Customer questions on a product with their answer counts. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3910467"
          description: Product id
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Questions per page, at most 50
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kohls/reviews:
    get:
      operationId: kohls_reviews
      tags:
        - Kohl's
      summary: Kohl's product reviews
      description: "Shopper reviews of a product: rating, title, text, author, location, verified purchase, recommendation and secondary ratings such as fit and comfort. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "3910467"
          description: Product id, the number after prd- in the product URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "8"
          description: Reviews per page, at most 50
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kohls/search:
    get:
      operationId: kohls_search
      tags:
        - Kohl's
      summary: Kohl's product search
      description: "Products matching a keyword: price band, rating, colours, shipping and pickup availability. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: tshirt
          description: Search keyword
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "24"
          description: Products per page, at most 120
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Sort id from a previous answer's sorts list
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kohls/stores:
    get:
      operationId: kohls_stores
      tags:
        - Kohl's
      summary: Kohl's store locator
      description: "Stores near a point: name, address, coordinates, page and specialties. Costs 1 credit per successful live response."
      parameters:
        - name: latitude
          in: query
          required: true
          schema:
            type: string
          example: "40.941111"
          description: Latitude
        - name: longitude
          in: query
          required: true
          schema:
            type: string
          example: "-73.982308"
          description: Longitude
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Search radius in miles
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/komi/page:
    get:
      operationId: komi_page
      tags:
        - Komi
      summary: Komi page
      description: Creator identity and every outbound link on a public Komi page. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://komi.io/example
          description: Full Komi URL or the bare handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kwai/post:
    get:
      operationId: kwai_post
      tags:
        - Kwai
      summary: Kwai post
      description: One post with its counts, author and music. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.kwai.com/@KwaiBrasilOficial/photo/5222073878527655516
          description: Post URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kwai/posts:
    get:
      operationId: kwai_posts
      tags:
        - Kwai
      summary: Kwai posts
      description: "A user's posts, one page at a time: caption, time, video and cover URLs, and view, like, comment and share counts. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: KwaiBrasilOficial
          description: Kwai handle (or pass url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.kwai.com/@KwaiBrasilOficial
          description: Profile URL, instead of handle
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/kwai/profile:
    get:
      operationId: kwai_profile
      tags:
        - Kwai
      summary: Kwai profile
      description: "A public Kwai profile: handle, name, bio, verification, follower, following, like and post counts. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: KwaiBrasilOficial
          description: Kwai handle (or pass url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.kwai.com/@KwaiBrasilOficial
          description: Profile URL, instead of handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkbio/page:
    get:
      operationId: linkbio_page
      tags:
        - lnk.bio
      summary: Linkbio page
      description: Creator identity and every outbound link on a public Linkbio page. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://linkbio.co/linkbio
          description: Full Linkbio URL (linkbio.co) or the bare handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/comment-replies:
    get:
      operationId: linkedin_comment_replies
      tags:
        - LinkedIn
      summary: LinkedIn comment replies
      description: The replies to a LinkedIn comment, with text, likes and author. Replies are found for comments among the first thirty the reply source lists for the post; a comment beyond them answers 404. Costs 3 credits per successful live response.
      parameters:
        - name: post_id
          in: query
          required: true
          schema:
            type: string
          example: "7356711184831574036"
          description: The post's activity id or URL
        - name: comment_id
          in: query
          required: true
          schema:
            type: string
          example: "7356889832989626368"
          description: The comment id from linkedin/post-comments
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Page token from the previous answer
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/company:
    get:
      operationId: linkedin_company
      tags:
        - LinkedIn
      summary: Company page
      description: "A company's public LinkedIn page: industry, size, headquarters, follower and employee counts. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/company/nasa/
          description: LinkedIn company URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/company-affiliated-pages:
    get:
      operationId: linkedin_company_affiliated_pages
      tags:
        - LinkedIn
      summary: LinkedIn company affiliated pages
      description: "A company's affiliated and showcase pages: id, name, handle, URL, type, speciality, follower count and logo. Not paged upstream. Costs 3 credits per successful live response."
      parameters:
        - name: company_id
          in: query
          required: true
          schema:
            type: string
          example: "1441"
          description: The numeric LinkedIn company id (as linkedin/company answers it) or a company URL carrying it
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/company-job-count:
    get:
      operationId: linkedin_company_job_count
      tags:
        - LinkedIn
      summary: LinkedIn company open jobs
      description: The number of open jobs a company lists. Costs 3 credits per successful live response.
      parameters:
        - name: company_id
          in: query
          required: true
          schema:
            type: string
          example: "783611"
          description: The numeric LinkedIn company id (as linkedin/company answers it) or a company URL carrying it
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/company-jobs:
    get:
      operationId: linkedin_company_jobs
      tags:
        - LinkedIn
      summary: LinkedIn company jobs
      description: "Open roles at a company, one page at a time: title, location, posting time, employment type, seniority, remote flag, salary where stated and applicant count. Costs 3 credits per successful live response."
      parameters:
        - name: organization_id
          in: query
          required: true
          schema:
            type: string
          example: "1441"
          description: LinkedIn organisation id (from jobs/linkedin/organizations)
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: engineer
          description: Keywords to narrow the roles
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: London
          description: Country or city
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/company-people:
    get:
      operationId: linkedin_company_people
      tags:
        - LinkedIn
      summary: LinkedIn company employees
      description: "People who list the company as their employer, twelve a page with the total: name, headline and profile. Costs 3 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: microsoft
          description: The company's LinkedIn handle or page URL (or pass organization_id)
        - name: organization_id
          in: query
          required: false
          schema:
            type: string
          example: "1035"
          description: Numeric LinkedIn company id — alternative to handle
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Page number from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/company-posts:
    get:
      operationId: linkedin_company_posts
      tags:
        - LinkedIn
      summary: Company posts
      description: Recent posts from a company's LinkedIn page, one numbered page at a time. Costs 3 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/company/nasa/
          description: LinkedIn company URL.
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number, 1 to 7 (the supplier documents up to seven pages); omitted = the first page
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: "Continuation: the cursor from the previous answer (the next page number). Use it instead of page."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/company-profile:
    get:
      operationId: linkedin_company_profile
      tags:
        - LinkedIn
      summary: LinkedIn company record
      description: "The enriched record for one company: industry, description, type, size band, headcount and its change over a month, quarter and year, followers, founding year, headquarters, revenue and funding where known, and open-role count. Distinct from linkedin/company, which answers what the public page shows. Costs 5 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: google
          description: Company handle (the URL slug)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/company/google
          description: Full company URL, instead of the handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/group:
    get:
      operationId: linkedin_group
      tags:
        - LinkedIn
      summary: LinkedIn group
      description: "A LinkedIn group: name, members, description, rules, owners, industries and images. Costs 3 credits per successful live response."
      parameters:
        - name: group_id
          in: query
          required: true
          schema:
            type: string
          example: "62438"
          description: A LinkedIn group id or URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/group-posts:
    get:
      operationId: linkedin_group_posts
      tags:
        - LinkedIn
      summary: LinkedIn group posts
      description: Posts in a LinkedIn group with text, media, engagement and author, paged. Costs 3 credits per successful live response.
      parameters:
        - name: group_id
          in: query
          required: true
          schema:
            type: string
          example: "62438"
          description: A LinkedIn group id or URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/job:
    get:
      operationId: linkedin_job
      tags:
        - LinkedIn
      summary: LinkedIn job posting
      description: "One job posting in full: title, company, location, description, posting and last-seen times, employment type, seniority, remote flag, salary where stated, applicant count and the external apply link. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4344456572"
          description: Job id from a search result
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/person:
    get:
      operationId: linkedin_person
      tags:
        - LinkedIn
      summary: LinkedIn person record
      description: "The enriched record for one person: headline, summary, location, connections and followers, current role, full work history, education, skills, languages and links. Distinct from linkedin/profile, which answers what the public page shows. Email addresses are never returned. Costs 5 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: williamhgates
          description: Public profile handle (the URL slug)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/williamhgates
          description: Full profile URL, instead of the handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/post:
    get:
      operationId: linkedin_post
      tags:
        - LinkedIn
      summary: Post details
      description: "One LinkedIn post: text, author, like and comment counts, with a short comment preview. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/feed/update/urn:li:activity:7500971887234097153
          description: Full LinkedIn post URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/post-comments:
    get:
      operationId: linkedin_post_comments
      tags:
        - LinkedIn
      summary: LinkedIn post comments
      description: "A post's comments, ten a page with the total: text, time, likes, reply count, pinned and edited flags, the commenter's name, headline and profile. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/feed/update/urn:li:activity:7496695637644828672
          description: Post URL (or pass comments_urn from a profile-posts card, which saves a request)
        - name: comments_urn
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: urns.comments from a profile-posts card
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Page number from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/post-reactions:
    get:
      operationId: linkedin_post_reactions
      tags:
        - LinkedIn
      summary: LinkedIn post reactions
      description: "Who reacted to a post and how, ten a page with the total: reaction type, name, headline and profile. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/feed/update/urn:li:activity:7496695637644828672
          description: Post URL (or pass reactions_urn from a profile-posts card)
        - name: reactions_urn
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: urns.reactions from a profile-posts card
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Page number from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/post-reposts:
    get:
      operationId: linkedin_post_reposts
      tags:
        - LinkedIn
      summary: LinkedIn post reposts
      description: "Who reposted a post, ten a page with the total: the repost's own URL and commentary, the reposter's name and profile. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/feed/update/urn:li:activity:7496695637644828672
          description: Post URL (or pass reposts_urn from a profile-posts card)
        - name: reposts_urn
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: urns.reposts from a profile-posts card
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Page number from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/post-transcript:
    get:
      operationId: linkedin_post_transcript
      tags:
        - LinkedIn
      summary: Video transcript
      description: The spoken words of a video in a LinkedIn post as text. transcript is null when the video has no speech or captions — that is the honest answer, not an error. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/feed/update/urn:li:activity:7500971887234097153
          description: LinkedIn post URL containing a video under ~2 minutes.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/profile:
    get:
      operationId: linkedin_profile
      tags:
        - LinkedIn
      summary: Person profile
      description: "A person's public LinkedIn profile: headline, member id, about, location, followers and connections, experience, education, skills, languages and certifications. Recent posts are listed by linkedin/profile-posts. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: LinkedIn profile URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/profile-certifications:
    get:
      operationId: linkedin_profile_certifications
      tags:
        - LinkedIn
      summary: LinkedIn member certifications
      description: "A member's licences and certifications, one page at a time: title, issuing authority, issue date and credential link. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAARpiwIBp_SzoeHPlUfOvmtibe08Ea1iCh4
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-comments:
    get:
      operationId: linkedin_profile_comments
      tags:
        - LinkedIn
      summary: LinkedIn profile comments
      description: The posts a person recently commented on, twenty a page, each with the person's comment. Costs 3 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: satyanadella
          description: Public profile handle (the URL slug), or pass url
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella
          description: Full profile URL
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Page number from the previous page
        - name: pagination_token
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: pagination_token from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/profile-contact:
    get:
      operationId: linkedin_profile_contact
      tags:
        - LinkedIn
      summary: LinkedIn public contact details
      description: "A member's public contact card: websites and social handles. E-mail addresses, phone numbers and postal addresses are personal data and are withheld; the answer lists what was withheld. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-educations:
    get:
      operationId: linkedin_profile_educations
      tags:
        - LinkedIn
      summary: LinkedIn member education
      description: "A member's education history, one page at a time: school, degree and dates. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAARpiwIBp_SzoeHPlUfOvmtibe08Ea1iCh4
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-experiences:
    get:
      operationId: linkedin_profile_experiences
      tags:
        - LinkedIn
      summary: LinkedIn member experiences
      description: "A member's work experiences, one page at a time: title, employment type, location, dates, description, skills and the company (id, name, URL, logo). Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAAjpjWIBMh1iBR4OgSPK5GXetlQ6dYUT-qo
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-freshness:
    get:
      operationId: linkedin_profile_freshness
      tags:
        - LinkedIn
      summary: LinkedIn account freshness
      description: "The account-freshness panel of a member (not the About text): the month the account joined and how recently the contact details and profile photo changed. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAA8BYqEBCGLg_vT_ca6mMEqkpp9nVffJ3hc
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-honors:
    get:
      operationId: linkedin_profile_honors
      tags:
        - LinkedIn
      summary: LinkedIn member honours
      description: "A member's honours and awards, one page at a time: title, issuer, date and the associated organisation. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAC41xVEBx77koDz3k1eJ5E9t8UZ7g0IVGj4
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-images:
    get:
      operationId: linkedin_profile_images
      tags:
        - LinkedIn
      summary: LinkedIn member image posts
      description: "A member's posts that carry images, twenty per page with a continuation token: post id, URL, the images at every size and the relative posting time. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The token from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-interests-companies:
    get:
      operationId: linkedin_profile_interests_companies
      tags:
        - LinkedIn
      summary: LinkedIn member followed companies
      description: "The companies a member follows, one page at a time: id, name, URL, follower count and logo. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAEDH77YBEVIYXAaEwTicp5CcB_hR7DfFL9o
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-interests-groups:
    get:
      operationId: linkedin_profile_interests_groups
      tags:
        - LinkedIn
      summary: LinkedIn member groups
      description: "The groups a member belongs to, one page at a time: id, name, URL, member count and logo. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAAjpjWIBMh1iBR4OgSPK5GXetlQ6dYUT-qo
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-posts:
    get:
      operationId: linkedin_profile_posts
      tags:
        - LinkedIn
      summary: LinkedIn profile posts
      description: "A person's posts, newest first, twenty a page: text, media, links, like/comment/share counts with the reaction breakdown, and the engagement tokens the post-comments, post-reactions and post-reposts routes accept. Costs 3 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: satyanadella
          description: Public profile handle (the URL slug), or pass url
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella
          description: Full profile URL
        - name: media
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: "image or video: only posts carrying that media"
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Page number from the previous page
        - name: pagination_token
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: pagination_token from the previous page, passed alongside the cursor
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/profile-publications:
    get:
      operationId: linkedin_profile_publications
      tags:
        - LinkedIn
      summary: LinkedIn member publications
      description: "A member's publications, one page at a time: title, publisher, description, date and link. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAB8rG_UB7cstjC__gk5318uYsZOIVkyysi4
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-reactions:
    get:
      operationId: linkedin_profile_reactions
      tags:
        - LinkedIn
      summary: LinkedIn profile reactions
      description: The posts a person recently reacted to, twenty a page, in the profile-posts shape. Costs 3 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: satyanadella
          description: Public profile handle (the URL slug), or pass url
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella
          description: Full profile URL
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Page number from the previous page
        - name: pagination_token
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: pagination_token from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/profile-recommendations:
    get:
      operationId: linkedin_profile_recommendations
      tags:
        - LinkedIn
      summary: LinkedIn member recommendations
      description: "The recommendations a member received or gave, one page at a time: text, date, relationship and the recommender. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAC3iNKcB3qbWJrP7K5Z3i89AF5c1snr8bhc
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: received
          description: received (default) or given
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: pagination_token
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The supplier's pagination token, forwarded as given
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-skills:
    get:
      operationId: linkedin_profile_skills
      tags:
        - LinkedIn
      summary: LinkedIn member skills
      description: "A member's skills, twenty per page: name, endorsement count and whether the skill assessment was passed. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAACkphDcBDruPBdXiAnqyc834jkTkd_4kRnU
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-stats:
    get:
      operationId: linkedin_profile_stats
      tags:
        - LinkedIn
      summary: LinkedIn follower and connection counts
      description: A member's follower and connection counts. Costs 3 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-videos:
    get:
      operationId: linkedin_profile_videos
      tags:
        - LinkedIn
      summary: LinkedIn member video posts
      description: "A member's video posts, paged with a continuation token: post id, URL, duration, thumbnail, like and comment counts and the reaction breakdown. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The token from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile-volunteers:
    get:
      operationId: linkedin_profile_volunteers
      tags:
        - LinkedIn
      summary: LinkedIn member volunteering
      description: "A member's volunteer experiences, one page at a time: organisation, role, cause, duration, description and dates. Costs 3 credits per successful live response."
      parameters:
        - name: urn
          in: query
          required: false
          schema:
            type: string
          example: ACoAAAWowRcBd8L3PJrg7-jrzLZGZeGBLz9kmSw
          description: The member URN (ACoAA…). Send this or url.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/in/satyanadella/
          description: Profile URL or handle, resolved to the URN by one extra supplier request (reported as urn_lookup)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/profile/full:
    get:
      operationId: linkedin_profile_full
      tags:
        - LinkedIn
      summary: LinkedIn profile with posts (one page)
      description: "A real public profile plus one page of posts/videos, preserving original normalized component fields and source order. HTTP 200 may be partial: inspect complete, partial and legs. Failed profile: no posts requested, zero charge. Failed posts: profile retained and only that successful component charged. Cached components use the public cache-hit price. Computed fields are transparent page arithmetic, not SocialCrawl metric-schema equivalence. Costs 6 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/company/microsoft
          description: Public profile identifier. LinkedIn accepts /company/name or /in/name URLs.
        - name: posts
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Desired page size, 1-100. Existing components choose their own page size; the entire single source page is preserved, even if longer or shorter, so no records are skipped between cursors. No automatic extra pages.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque posts_cursor from the previous response; use posts_pagination.next_params to retain all required context. Unsupported component continuation is refused before calls.
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: posts,computed
          description: "CSV: posts and/or computed (default both), or profile alone. Profile is always returned. Computed is arithmetic over this page only, not an AI summary."
        - name: pagination_token
          in: query
          required: false
          schema:
            type: string
          description: Pass with the cursor when the personal-profile posts page supplied it. Company continuation is rejected until its registered component supports it.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 6
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/linkedin/search-industries:
    get:
      operationId: linkedin_search_industries
      tags:
        - LinkedIn
      summary: LinkedIn industry lookup
      description: LinkedIn industries matching a typed name, each with the id the people-search industry filter takes. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Software
          description: The start of an industry name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/search-jobs:
    get:
      operationId: linkedin_search_jobs
      tags:
        - LinkedIn
      summary: LinkedIn job search
      description: Search job postings by free text, location, country or company, one page at a time, in the same posting shape as a company's jobs. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: data engineer
          description: Keywords, title, company or position (title accepted as an alias)
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: London
          description: Country or city; worldwide when empty
        - name: organization_ids
          in: query
          required: false
          schema:
            type: string
          example: "1441"
          description: Organisation ids from jobs/linkedin/organizations
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          example: week
          description: month, week or day
        - name: employment_types
          in: query
          required: false
          schema:
            type: string
          example: fulltime
          description: contractor, fulltime, parttime, intern or temporary
        - name: experience_levels
          in: query
          required: false
          schema:
            type: string
          example: midSenior
          description: intern, entry, associate, midSenior or director
        - name: workplace_types
          in: query
          required: false
          schema:
            type: string
          example: remote
          description: remote, hybrid or onSite
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/search-locations:
    get:
      operationId: linkedin_search_locations
      tags:
        - LinkedIn
      summary: LinkedIn location lookup
      description: LinkedIn locations matching a typed name, each with the id the people-search location filter takes. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: London
          description: The start of a place name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/search-people:
    get:
      operationId: linkedin_search_people
      tags:
        - LinkedIn
      summary: LinkedIn people search
      description: "People matching a name with optional title, location, company, school and industry filters: handle, headline, location, followers and badges. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Bill Gates
          description: A person's name
        - name: title
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Job title filter
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A location id from linkedin/search-locations
        - name: current_company
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Current company filter
        - name: past_company
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Past company filter
        - name: school
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A school id from linkedin/search-schools
        - name: industry
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: An industry id from linkedin/search-industries
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/search-posts:
    get:
      operationId: linkedin_search_posts
      tags:
        - LinkedIn
      summary: Post search
      description: "Search public LinkedIn posts by keyword: post text, author and URL. Paged by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: artificial intelligence
          description: Search term.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Page number cursor from the previous page.
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          description: Restrict by post date, e.g. past-week.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin/search-schools:
    get:
      operationId: linkedin_search_schools
      tags:
        - LinkedIn
      summary: LinkedIn school lookup
      description: LinkedIn schools matching a typed name, each with the id the people-search school filter takes. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Stanford
          description: The start of a school name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin_ads/ad:
    get:
      operationId: linkedin_ads_ad
      tags:
        - LinkedIn Ads
      summary: Ad details
      description: "One LinkedIn ad by its ad-library URL: creative, advertiser, targeting disclosures and impression data. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.linkedin.com/ad-library/detail/1507751473
          description: LinkedIn ad-library detail URL from a search result.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkedin_ads/search:
    get:
      operationId: linkedin_ads_search
      tags:
        - LinkedIn Ads
      summary: Ad search
      description: "Search the LinkedIn Ad Library: headline, body, ad type, advertiser, impression bands and per-country impressions. Paged by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: cloud
          description: Keyword (or pass company / companyId for advertiser-specific results).
        - name: company
          in: query
          required: false
          schema:
            type: string
          example: microsoft
          description: Company name.
        - name: companyId
          in: query
          required: false
          schema:
            type: string
          description: LinkedIn company id.
        - name: countries
          in: query
          required: false
          schema:
            type: string
          example: US,CA
          description: Comma list of two-letter codes.
        - name: start_date
          in: query
          required: false
          schema:
            type: string
          description: YYYY-MM-DD.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
          description: YYYY-MM-DD.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: paginationToken from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linkme/page:
    get:
      operationId: linkme_page
      tags:
        - LinkMe
      summary: Linkme profile
      description: Creator identity and every outbound link on a public Linkme profile. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://linkme.bio/example
          description: Full Linkme URL or the bare handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/linktree/page:
    get:
      operationId: linktree_page
      tags:
        - Linktree
      summary: Linktree page
      description: Creator identity and every outbound link on a public Linktree page. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://linktr.ee/linktree
          description: Full Linktree URL or the bare handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/meta_ads/ad:
    get:
      operationId: meta_ads_ad
      tags:
        - Meta Ad Library
      summary: Ad details
      description: "One Meta ad by archive id: full creative snapshot, platforms, run dates, and spend/reach where the Ad Library discloses them. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1702938977100376"
          description: Ad archive id from a search or company-ads result.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/meta_ads/ad-transcript:
    get:
      operationId: meta_ads_ad_transcript
      tags:
        - Meta Ad Library
      summary: Ad transcript
      description: The spoken words of a Meta video ad as text. transcript is null when the video has no speech — that is the honest answer, not an error. Costs 5 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "4439810673014351"
          description: Ad archive id of a VIDEO ad.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/meta_ads/company-ads:
    get:
      operationId: meta_ads_company_ads
      tags:
        - Meta Ad Library
      summary: Company ads
      description: "Ads currently or previously running for one advertiser: creative body, title, CTA, link, images/videos, platforms and active state. Paged by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: pageId
          in: query
          required: true
          schema:
            type: string
          example: "15087023444"
          description: Facebook page id from meta_ads/search-companies (or pass companyName instead).
        - name: companyName
          in: query
          required: false
          schema:
            type: string
          description: Company name — alternative to pageId.
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: ALL
          description: Two-letter country code or ALL.
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: ACTIVE, INACTIVE or ALL.
        - name: media_type
          in: query
          required: false
          schema:
            type: string
          description: ALL, IMAGE or VIDEO.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: e.g. total_impressions.
        - name: start_date
          in: query
          required: false
          schema:
            type: string
          description: YYYY-MM-DD.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
          description: YYYY-MM-DD.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/meta_ads/search:
    get:
      operationId: meta_ads_search
      tags:
        - Meta Ad Library
      summary: Ad search
      description: "Keyword search across the Meta Ad Library: matching ads with advertiser page, creative snapshot and platforms. Paged by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: running shoes
          description: Keyword to search ad creatives for.
        - name: country
          in: query
          required: false
          schema:
            type: string
          description: Two-letter country code or ALL.
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: ACTIVE, INACTIVE or ALL.
        - name: media_type
          in: query
          required: false
          schema:
            type: string
          description: ALL, IMAGE or VIDEO.
        - name: ad_type
          in: query
          required: false
          schema:
            type: string
          description: e.g. all.
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: EN
          description: Two-letter language code.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: e.g. total_impressions.
        - name: start_date
          in: query
          required: false
          schema:
            type: string
          description: YYYY-MM-DD.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
          description: YYYY-MM-DD.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/meta_ads/search-companies:
    get:
      operationId: meta_ads_search_companies
      tags:
        - Meta Ad Library
      summary: Advertiser search
      description: "Search Meta Ad Library advertisers: page id, name, category, likes, verification and Instagram handle. The page id feeds meta_ads/company-ads. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: nike
          description: Company or brand name.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/analytics:
    get:
      operationId: monitors_analytics
      tags:
        - Monitors
      summary: Monitoring analytics
      description: "Your monitoring at a glance: monitors by state, runs, findings, suppressed duplicates, alert delivery, credits, upstream cost and cache savings, and time to first finding. Free — costs 0 credits."
      parameters:
        - name: days
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Window, up to 90 days
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/create:
    get:
      operationId: monitors_create
      tags:
        - Monitors
      summary: Create a monitor
      description: Save a monitor and its schedule. A subject monitor follows a resolved name across platforms and records only what is new; a feed monitor records new items from one review or listing endpoint; a change monitor snapshots a page or endpoint. Creating costs the listed credits; each run of a subject or feed monitor is charged separately, up to its monthly cap. Costs 1 credit per successful live response.
      parameters:
        - name: kind
          in: query
          required: false
          schema:
            type: string
          example: subject
          description: "What kind of monitor: subject (a name, handle, product or topic followed across platforms), feed (new items from one review or listing endpoint) or change (a page or endpoint snapshot, the original monitor). Defaults to subject when query is given, change otherwise."
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: Monzo
          description: "What to watch: a name, product, handle, domain or keyword for a subject monitor; for a feed template, its identifier — a subreddit, a video link, an app id, or for Google Maps reviews a pasted Maps link or a Place id (a link is resolved through one places search, charged once)."
        - name: entity
          in: query
          required: false
          schema:
            type: string
          example: bare
          description: "subject: the sense id chosen from a preview or a clarification (bare for the plain name, sense:… for a qualified one)"
        - name: entity_type
          in: query
          required: false
          schema:
            type: string
          example: brand
          description: "subject: creator_media, developer, brand, company, event or community — guides source routing"
        - name: purpose
          in: query
          required: false
          schema:
            type: string
          example: complaints
          description: A preset id (brand_mentions, complaints, competitor_activity, switching_intent, purchase_intent, questions, developments, app_reviews, local_reviews, custom) or a short free-text purpose
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: reddit,x,hackernews
          description: "subject: platforms to search, comma-separated; defaults to the preset's recommendation"
        - name: exclude
          in: query
          required: false
          schema:
            type: string
          example: tiktok
          description: "subject: platforms to leave out"
        - name: relationships
          in: query
          required: false
          schema:
            type: string
          example: independent_audience,editorial_news
          description: "subject: which classes of material count as findings (official_owned, employee_team, collaborator_partner, editorial_news, fan_clip, independent_audience). Default: everything except unrelated material."
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: complaints
          description: "subject: deterministic purpose filters applied to findings: complaints, switching, buying, questions"
        - name: aliases
          in: query
          required: false
          schema:
            type: string
          example: "@monzo,Monzo Bank"
          description: "subject: other names the subject is known by, comma-separated"
        - name: exclusions
          in: query
          required: false
          schema:
            type: string
          example: Monzó
          description: "subject: phrases that mark a namesake; a finding containing one is dropped"
        - name: max_metered
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: "subject: how many metered platforms each run may spend on, 0-2 (default 1)"
        - name: lookback_days
          in: query
          required: false
          schema:
            type: string
          example: "7"
          description: "subject: how far back the first run looks (default 7); later runs continue from the last successful run"
        - name: feed_platform
          in: query
          required: false
          schema:
            type: string
          example: app_store
          description: "feed: platform of the review or listing endpoint"
        - name: feed_endpoint
          in: query
          required: false
          schema:
            type: string
          example: app-reviews
          description: "feed: endpoint id, e.g. app-reviews"
        - name: feed_params_json
          in: query
          required: false
          schema:
            type: string
          example: "{\"app_id\":\"310633997\"}"
          description: "feed: JSON object of parameters for the endpoint"
        - name: schedule_minutes
          in: query
          required: false
          schema:
            type: string
          example: "1440"
          description: Minutes between runs. The console offers 60, 360, 1440 and 10080; the API accepts any value from 15 to 43200.
        - name: monthly_cap_credits
          in: query
          required: false
          schema:
            type: string
          example: "300"
          description: "subject/feed: the most credits this monitor may spend in a calendar month (default 300, maximum 5000). Runs are skipped, never charged, once the cap is reached."
        - name: delivery_in_app
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Create an in-app notification when a run finds something new (default true)
        - name: delivery_webhook
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Emit monitor.findings to your signed webhook endpoints (default false)
        - name: name
          in: query
          required: false
          schema:
            type: string
          example: Monzo complaints
          description: Human label; suggested from the purpose and subject when omitted
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://example.com/pricing
          description: "change: page to watch. Give this OR platform+endpoint."
        - name: platform
          in: query
          required: false
          schema:
            type: string
          example: github
          description: "change: platform of an API endpoint to watch, e.g. github. Give with endpoint."
        - name: endpoint
          in: query
          required: false
          schema:
            type: string
          example: repo
          description: "change: endpoint id to watch, e.g. repo"
        - name: params_json
          in: query
          required: false
          schema:
            type: string
          example: "{\"owner\":\"vercel\",\"repo\":\"next.js\"}"
          description: "change: JSON object of parameters passed to the watched endpoint on every run"
        - name: output
          in: query
          required: false
          schema:
            type: string
          example: report
          description: "subject and feed: report (each run leads with what changed and why it matters, every line with its receipts; the default for the intelligence templates) or everything (every new post, comment or review, listed; the default for feeds and follow templates)"
        - name: destinations
          in: query
          required: false
          schema:
            type: string
          example: "[{\"kind\":\"endpoint\",\"endpoint_id\":\"whk_…\",\"cadence\":\"immediate\",\"min_severity\":\"notable\"},{\"kind\":\"email\",\"cadence\":\"daily\"}]"
          description: "JSON array of where alerts go and how often. kind: email (the account address), endpoint (one of your Slack channels, Discord channels or webhooks by endpoint_id; omit endpoint_id for every active endpoint), push (the devices that turned push on). cadence: immediate, daily or weekly. min_severity for immediate: info (every new finding), notable or critical. The monitor page is always included unless delivery_in_app=false. Replaces delivery_email, delivery_webhook and delivery_mode when given."
        - name: feeds_json
          in: query
          required: false
          schema:
            type: string
          example: "[{\"platform\":\"bluesky\",\"endpoint\":\"user/posts\",\"params\":{\"handle\":\"name.bsky.social\"}},{\"platform\":\"youtube\",\"endpoint\":\"channel/videos\",\"params\":{\"handle\":\"name\"}}]"
          description: "Several feeds at once, as a JSON array of {platform, endpoint, params}. Follow an account reads timelines: x/tweets (handle, metered), bluesky/user/posts (handle), youtube/channel/videos (handle or url). Every feed must be live-proven on this deployment; the review says so per feed."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/delete:
    get:
      operationId: monitors_delete
      tags:
        - Monitors
      summary: Delete a monitor
      description: "Permanently delete one of your monitors and its recorded run history, and cancel any check already queued for it. A Monocrawl extra: the reference catalogue catalogue has no monitor delete call, which makes its per-account monitor limit unrecoverable. This cannot be undone. Free — costs 0 credits."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Monitor id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/drafts:
    get:
      operationId: monitors_drafts
      tags:
        - Monitors
      summary: Monitor drafts
      description: The proposals waiting for review. A draft is saved, edited, tested and finally activated into a monitor or discarded; nothing runs or is charged while it is a draft. Free — costs 0 credits.
      parameters:
        - name: draft_id
          in: query
          required: false
          schema:
            type: string
          example: drf_…
          description: One draft; without it, every open draft
        - name: proposal_json
          in: query
          required: false
          schema:
            type: string
          example: "{…}"
          description: "With draft_id: replace the proposal (edited in the review)"
        - name: activate
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: "With draft_id: create the monitor from the proposal and close the draft"
        - name: discard
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: "With draft_id: close the draft without creating anything"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/export:
    get:
      operationId: monitors_export
      tags:
        - Monitors
      summary: Export the evidence
      description: Every finding in the window with its receipts — source, quote, link, author, posted time, severity, matches, story, topic, your verdict and the raw evidence row it was made from — as CSV or JSON. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_…
          description: Monitor id
        - name: format
          in: query
          required: false
          schema:
            type: string
          example: csv
          description: csv (default) or json
        - name: days
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Window, up to 365 days
        - name: feedback
          in: query
          required: false
          schema:
            type: string
          example: useful
          description: Only findings with this verdict
        - name: scope
          in: query
          required: false
          schema:
            type: string
          example: collected
          description: "findings (default): the retained findings of the window. collected: every item one run collected, retained or not, with the decision and the reason; needs run_id, or takes the latest run. Runs before 5 September 2026 did not keep their collected items and say so."
        - name: run_id
          in: query
          required: false
          schema:
            type: string
          example: "1396"
          description: "With scope=collected: the run to export. Defaults to the latest run."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/feedback:
    get:
      operationId: monitors_feedback
      tags:
        - Monitors
      summary: Mark findings known, resolved, irrelevant or useful
      description: "Records your verdict on findings and remembers it: what you mark known, resolved or irrelevant is not surfaced again by later runs (the same conversation, link, wording, topic or, for irrelevant, author), and what you mark useful is kept as a positive example for the relevance filter. Free — costs 0 credits."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_…
          description: Monitor id
        - name: ids
          in: query
          required: true
          schema:
            type: string
          example: fnd_…,fnd_…
          description: Finding ids, comma-separated
        - name: verdict
          in: query
          required: true
          schema:
            type: string
          example: irrelevant
          description: known, resolved, irrelevant or useful
        - name: scope
          in: query
          required: false
          schema:
            type: string
          example: story
          description: "finding (default) or story: apply to the whole story the findings belong to"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/findings:
    get:
      operationId: monitors_findings
      tags:
        - Monitors
      summary: List monitor findings
      description: "The findings a subject or feed monitor has recorded, newest first: each with its platform, author, link, posted time, relationship to the subject and the purpose filters it matched. A finding is recorded once per monitor, however many runs see it. Free — costs 0 credits."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Monitor id
        - name: unseen
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Only findings not yet marked as seen
        - name: run_id
          in: query
          required: false
          schema:
            type: string
          example: "42"
          description: Only findings first recorded by this run
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Page size, 1-200 (default 50)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
        - name: mark_seen
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Mark the returned findings as seen
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/get:
    get:
      operationId: monitors_get
      tags:
        - Monitors
      summary: Get a monitor
      description: One monitor with its target, schedule and the summary of its most recent run. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Monitor id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/health:
    get:
      operationId: monitors_health
      tags:
        - Monitors
      summary: Monitor health
      description: "A monitor's health and coverage: consecutive failures, missed checks, stale sources, provider failures, which configured sources are live, and what its checks cost and avoided. Free — costs 0 credits."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_…
          description: Monitor id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors:
    get:
      operationId: monitors_index
      tags:
        - Monitors
      summary: List monitors
      description: Your monitors, newest first, with each one's schedule and next due time. Free — costs 0 credits.
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
          example: active
          description: "Filter by monitor status: active or paused"
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Page size, 1-100 (default 25)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/preview:
    get:
      operationId: monitors_preview
      tags:
        - Monitors
      summary: Preview a monitor
      description: "What a subject monitor would do, before it exists: the resolved subject or the senses to choose from, the recommended platforms with reasons, the schedule, the credit estimate from the price list, and a few pieces of no-cost evidence. Runs the free first pass only — no metered platform and no paid fallback is touched. Free — costs 0 credits."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Monzo
          description: The name, handle, URL, domain, product or keyword to follow
        - name: entity
          in: query
          required: false
          schema:
            type: string
          example: bare
          description: A sense id from an earlier preview, when the name was ambiguous
        - name: entity_type
          in: query
          required: false
          schema:
            type: string
          example: brand
          description: Optional type hint
        - name: purpose
          in: query
          required: false
          schema:
            type: string
          example: complaints
          description: Preset id or free text; sets the recommended sources and filters
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: reddit,x
          description: Override the recommended platforms
        - name: schedule_minutes
          in: query
          required: false
          schema:
            type: string
          example: "1440"
          description: Interval used for the monthly estimate
        - name: monthly_cap_credits
          in: query
          required: false
          schema:
            type: string
          example: "300"
          description: Cap used for the monthly estimate
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/propose:
    get:
      operationId: monitors_propose
      tags:
        - Monitors
      summary: Propose a monitor from plain English
      description: "Turns a plain-English request into a complete, editable monitor proposal: what it watches, the identifiers it found, the platforms, the matching rules and exclusions, the frequency, the delivery and the estimated cost, with the reason for each choice. Nothing is created. Free — costs 0 credits."
      parameters:
        - name: text
          in: query
          required: true
          schema:
            type: string
          example: Tell me when people complain about Monzo on Reddit or Hacker News
          description: What you want to keep an eye on, in a sentence
        - name: template
          in: query
          required: false
          schema:
            type: string
          example: complaints
          description: Start from a template id instead of, or as well as, the sentence
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/report:
    get:
      operationId: monitors_report
      tags:
        - Monitors
      summary: Save findings as a report
      description: Turns a monitor's findings (or one story) into a saved research report with citations, verified facts kept apart from generated interpretation, ready to share or export as Markdown or JSON. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_…
          description: Monitor id
        - name: story_id
          in: query
          required: false
          schema:
            type: string
          example: sty_…
          description: Only this story's findings
        - name: days
          in: query
          required: false
          schema:
            type: string
          example: "7"
          description: Findings from the last N days (default 7)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/run:
    get:
      operationId: monitors_run
      tags:
        - Monitors
      summary: Run a monitor now
      description: Queue one run of a subject or feed monitor outside its schedule. The estimate is returned first; the run is charged at that estimate when you confirm, refunded down to what was actually retrieved, and skipped without a charge if the monthly cap would be exceeded. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Monitor id
        - name: confirm
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Without confirm=true the call only returns what a run would cost. With it, the run is charged and queued.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/runs:
    get:
      operationId: monitors_runs
      tags:
        - Monitors
      summary: List monitor runs
      description: The check history for a monitor, newest first, with what changed on each run. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Monitor id
        - name: status
          in: query
          required: false
          schema:
            type: string
          example: ok
          description: "Filter by run status: ok or error"
        - name: from
          in: query
          required: false
          schema:
            type: string
          example: "2026-01-01T00:00:00Z"
          description: Only runs at or after this ISO-8601 time
        - name: to
          in: query
          required: false
          schema:
            type: string
          example: "2026-02-01T00:00:00Z"
          description: Only runs at or before this ISO-8601 time
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: snapshot,diff
          description: "Add the heavy fields: snapshot and/or diff (omitted by default)"
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Page size, 1-100 (default 25)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/settings:
    get:
      operationId: monitors_settings
      tags:
        - Monitors
      summary: Monitoring settings
      description: Read or change the account-wide monitor budget and the digest schedule. Reads with no parameters; writes with any of them. Free — costs 0 credits.
      parameters:
        - name: monthly_budget_credits
          in: query
          required: false
          schema:
            type: string
          example: "1000"
          description: Account-wide monthly budget for monitor runs; empty for none
        - name: digest_frequency
          in: query
          required: false
          schema:
            type: string
          example: daily
          description: off, daily or weekly
        - name: digest_hour
          in: query
          required: false
          schema:
            type: string
          example: "8"
          description: UTC hour the digest is assembled
        - name: digest_email
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Send the digest by email
        - name: digest_webhook
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Send the digest to subscribed webhooks
        - name: digest_report
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Also save each digest as a research report
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/stories:
    get:
      operationId: monitors_stories
      tags:
        - Monitors
      summary: Monitor stories
      description: The developing stories a monitor's related findings have been grouped into, with counts, severity and when each was last seen. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_…
          description: Monitor id
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Stories, newest first
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/test:
    get:
      operationId: monitors_test
      tags:
        - Monitors
      summary: Test a monitor now
      description: Run one real check for a monitor that does not exist yet and see what you would have been told about. Charged like one run and refunded down to what was retrieved; nothing is recorded and nothing is sent. Free — costs 0 credits.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Monzo
          description: The name, handle, URL, domain, product or keyword the monitor would follow
        - name: entity
          in: query
          required: false
          schema:
            type: string
          example: bare
          description: A sense id from a preview when the name was ambiguous
        - name: purpose
          in: query
          required: false
          schema:
            type: string
          example: complaints
          description: Template id or free text
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: reddit,x
          description: Platforms to search
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: complaints
          description: Purpose filters
        - name: exclusions
          in: query
          required: false
          schema:
            type: string
          example: hiring,job opening
          description: Skip anything containing one of these
        - name: relevance_prompt
          in: query
          required: false
          schema:
            type: string
          example: People genuinely discussing the product, not job listings
          description: Plain-English relevance description, judged by the model when one is configured
        - name: confirm
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Without confirm=true the call only returns what the test would cost. With it, the test is charged like one run.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/test-delivery:
    get:
      operationId: monitors_test_delivery
      tags:
        - Monitors
      summary: Send a sample alert
      description: "Sends one clearly-marked sample alert (a short report with receipts) to the destinations given, right now, and reports what each one answered. Nothing is recorded, nothing is charged, and no real finding is involved: it proves the channel works before a monitor is switched on. Free — costs 0 credits."
      parameters:
        - name: destinations
          in: query
          required: true
          schema:
            type: string
          example: "[{\"kind\":\"endpoint\",\"endpoint_id\":\"whk_…\"}]"
          description: The destinations to send the sample to, as for monitors/create
        - name: name
          in: query
          required: false
          schema:
            type: string
          example: Monzo complaints
          description: The monitor name to show on the sample
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: mon_…
          description: "The monitor the sample is sent from, when it already exists: the sample then links to that monitor’s page and takes its name. Without it, the sample links to the monitors list."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/timeseries:
    get:
      operationId: monitors_timeseries
      tags:
        - Monitors
      summary: Monitor metric timeseries
      description: One numeric metric from a monitor's runs as a chartable time series. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Monitor id
        - name: metric
          in: query
          required: true
          schema:
            type: string
          example: content_length
          description: Metric key to chart; a 422 lists the metrics this monitor has recorded
        - name: from
          in: query
          required: false
          schema:
            type: string
          example: "2026-01-01T00:00:00Z"
          description: Only points at or after this ISO-8601 time
        - name: to
          in: query
          required: false
          schema:
            type: string
          example: "2026-02-01T00:00:00Z"
          description: Only points at or before this ISO-8601 time
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/monitors/trends:
    get:
      operationId: monitors_trends
      tags:
        - Monitors
      summary: Monitor trends
      description: A metric over time with the previous period and the baseline beside it, so a change can be judged against what is normal for this monitor. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_…
          description: Monitor id
        - name: metric
          in: query
          required: false
          schema:
            type: string
          example: findings
          description: findings, or any numeric metric the runs record
        - name: days
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Window, up to 90 days
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/monitors/update:
    get:
      operationId: monitors_update
      tags:
        - Monitors
      summary: Update a monitor
      description: Pause, resume, rename, reschedule or re-scope one of your monitors. Give at least one field besides id. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: mon_0f2c8b1d4e6a7c9b0d1e2f3a
          description: Monitor id
        - name: status
          in: query
          required: false
          schema:
            type: string
          example: paused
          description: active to resume runs, paused to stop them. Pausing clears the next run time; resuming schedules the next run one interval from now.
        - name: name
          in: query
          required: false
          schema:
            type: string
          example: Monzo complaints
          description: New label; pass an empty string to clear it
        - name: schedule_minutes
          in: query
          required: false
          schema:
            type: string
          example: "1440"
          description: New interval between runs; minimum 15, maximum 43200. Rescheduling re-times the next run from now.
        - name: monthly_cap_credits
          in: query
          required: false
          schema:
            type: string
          example: "500"
          description: "subject/feed: new monthly cap, 0-5000"
        - name: delivery_in_app
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: "subject/feed: in-app notifications on or off"
        - name: delivery_webhook
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: "subject/feed: signed webhook deliveries on or off"
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: reddit,hackernews
          description: "subject: replace the platforms searched"
        - name: relationships
          in: query
          required: false
          schema:
            type: string
          example: independent_audience
          description: "subject: replace which classes of material count"
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: complaints
          description: "subject: replace the purpose filters"
        - name: exclusions
          in: query
          required: false
          schema:
            type: string
          example: Monzó
          description: "subject: replace the namesake phrases"
        - name: max_metered
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: "subject: metered platforms per run, 0-2"
        - name: output
          in: query
          required: false
          schema:
            type: string
          example: report
          description: "subject and feed: report (each run leads with what changed and why it matters, every line with its receipts; the default for the intelligence templates) or everything (every new post, comment or review, listed; the default for feeds and follow templates)"
        - name: destinations
          in: query
          required: false
          schema:
            type: string
          example: "[{\"kind\":\"endpoint\",\"endpoint_id\":\"whk_…\",\"cadence\":\"immediate\",\"min_severity\":\"notable\"},{\"kind\":\"email\",\"cadence\":\"daily\"}]"
          description: "JSON array of where alerts go and how often. kind: email (the account address), endpoint (one of your Slack channels, Discord channels or webhooks by endpoint_id; omit endpoint_id for every active endpoint), push (the devices that turned push on). cadence: immediate, daily or weekly. min_severity for immediate: info (every new finding), notable or critical. The monitor page is always included unless delivery_in_app=false. Replaces delivery_email, delivery_webhook and delivery_mode when given."
        - name: feeds_json
          in: query
          required: false
          schema:
            type: string
          example: "[{\"platform\":\"bluesky\",\"endpoint\":\"user/posts\",\"params\":{\"handle\":\"name.bsky.social\"}},{\"platform\":\"youtube\",\"endpoint\":\"channel/videos\",\"params\":{\"handle\":\"name\"}}]"
          description: "Several feeds at once, as a JSON array of {platform, endpoint, params}. Follow an account reads timelines: x/tweets (handle, metered), bluesky/user/posts (handle), youtube/channel/videos (handle or url). Every feed must be live-proven on this deployment; the review says so per feed."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/on_page/page:
    get:
      operationId: on_page_page
      tags:
        - On-Page
      summary: On-page SEO audit
      description: "On-page SEO audit of one URL: title and meta description checks, heading structure, image alt coverage, internal/external links, canonical, robots meta, social tags, HTTPS, word count, and a severity-ranked findings list. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://example.com
          description: Page URL to audit (http/https, public hosts only)
        - name: timeout
          in: query
          required: false
          schema:
            type: string
          example: "10000"
          description: Fetch budget in milliseconds, clamped to 1000-15000
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/ai-visibility:
    get:
      operationId: panorama_ai_visibility
      tags:
        - Panorama
      summary: AI visibility
      description: How often each answer engine names the brand and its competitors across repeated runs of the prompts, per engine, with the domains the engines cited ranked. Costs are the engines' metered model prices. Costs 30 credits per successful live response.
      parameters:
        - name: brand
          in: query
          required: true
          schema:
            type: string
          example: Monzo
          description: The brand to measure
        - name: prompts
          in: query
          required: false
          schema:
            type: string
          example: "[\"best UK banking apps\",\"which bank should I open a savings account with\"]"
          description: Prompts to ask (JSON array or |-separated). Or send topic.
        - name: topic
          in: query
          required: false
          schema:
            type: string
          example: UK banking apps
          description: A topic to generate one prompt from when prompts are not given
        - name: competitors
          in: query
          required: false
          schema:
            type: string
          example: Starling,Revolut
          description: Comma-separated competitor names (up to 5)
        - name: engines
          in: query
          required: false
          schema:
            type: string
          example: perplexity,grok
          description: "Comma-separated engines: perplexity, grok (default both)"
        - name: runs
          in: query
          required: false
          schema:
            type: string
          example: "4"
          description: Runs per prompt per engine, 1 to 20 (the preset's default otherwise)
        - name: preset
          in: query
          required: false
          schema:
            type: string
          example: quick
          description: quick (2 runs, 3 prompts), standard (4 runs, 8 prompts) or deep (8 runs, 20 prompts)
        - name: brand_domains
          in: query
          required: false
          schema:
            type: string
          example: monzo.com
          description: Comma-separated domains that count as the brand when cited
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 30
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/panorama/answers:
    get:
      operationId: panorama_answers
      tags:
        - Panorama
      summary: Multi-engine answers
      description: "The same question asked of Perplexity and xAI in parallel: each engine's answer verbatim with its citations, a merged citation list saying which engines cited each source, an agreement matrix and each engine's dollar cost. Costs 10 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Which UK banks offer the best savings rates this month?
          description: The question, sent verbatim to every engine
        - name: engines
          in: query
          required: false
          schema:
            type: string
          example: perplexity,grok
          description: "Comma-separated engines: perplexity, grok (default both)"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/panorama/audience-overlap:
    get:
      operationId: panorama_audience_overlap
      tags:
        - Panorama
      summary: Audience overlap
      description: "How much two creators' commenter audiences overlap: shared commenters, Jaccard index, a-only and b-only counts and a confidence from the sample sizes, computed deterministically from sampled posts and comments. Costs 10 credits per successful live response."
      parameters:
        - name: handle_a
          in: query
          required: true
          schema:
            type: string
          example: mkbhd
          description: First creator handle
        - name: handle_b
          in: query
          required: true
          schema:
            type: string
          example: mrwhosetheboss
          description: Second creator handle
        - name: platform
          in: query
          required: false
          schema:
            type: string
          example: tiktok
          description: tiktok (default), instagram or x
        - name: videos_per_creator
          in: query
          required: false
          schema:
            type: string
          example: "5"
          description: Recent posts sampled per creator, 1 to 10
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Comments read per post, 10 to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/brand-mentions:
    get:
      operationId: panorama_brand_mentions
      tags:
        - Panorama
      summary: Brand mentions
      description: "Every mention of one brand across the live sources in the window: evidence items with links and engagement, per-source counts, and a per-day timeline built only from items that carry timestamps. Costs 5 credits per successful live response."
      parameters:
        - name: brand
          in: query
          required: true
          schema:
            type: string
          example: minoapi
          description: The brand or product to find mentions of
        - name: lookback_days
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Mention window in days (default 30)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/campaign:
    get:
      operationId: panorama_campaign
      tags:
        - Panorama
      summary: Campaign lift
      description: "Volume before, during and after a campaign window across TikTok, Instagram, X and YouTube for a hashtag or phrase: daily rates, lift, whether the floor held afterwards, per-platform engagement and the amplifiers with the most engagement during the window. Costs 30 credits per successful live response."
      parameters:
        - name: hashtag
          in: query
          required: true
          schema:
            type: string
          example: justdoit
          description: Campaign hashtag (or pass phrase)
        - name: phrase
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A phrase instead of a hashtag
        - name: window_start
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-28"
          description: ISO start of the campaign window (default 7 days before window_end)
        - name: window_end
          in: query
          required: false
          schema:
            type: string
          example: "2026-09-04"
          description: ISO end (default now)
        - name: pre_days
          in: query
          required: false
          schema:
            type: string
          example: "7"
          description: Baseline days before the window
        - name: post_days
          in: query
          required: false
          schema:
            type: string
          example: "7"
          description: Days after the window
        - name: platforms
          in: query
          required: false
          schema:
            type: string
          example: tiktok,instagram,x,youtube
          description: Platforms to read
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 30
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/comment-lookup:
    get:
      operationId: panorama_comment_lookup
      tags:
        - Panorama
      summary: Batch comment re-check
      description: Re-check up to 25 known comments in one call — current author, text, score and timestamp per item. References that share a parent post share a single upstream call. Supports hackernews items, reddit comments and github issue comments; a comment that has been deleted, or that sits behind an unexpanded Reddit "more" stub, is reported in failed[] rather than guessed. Costs 3 credits per successful live response.
      parameters:
        - name: comments
          in: query
          required: true
          schema:
            type: string
          example: hackernews:8917,https://www.reddit.com/r/rust/comments/1abcdef/slug/lm3n4op/
          description: "Up to 25 comment references, comma or newline separated (a JSON array also works). Accepted forms: a Hacker News item link or hackernews:{id}; a Reddit COMMENT permalink or reddit:{postId}/{commentId}; a GitHub comment permalink (…/issues/12#issuecomment-123)."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/comments:
    get:
      operationId: panorama_comments
      tags:
        - Panorama
      summary: Whole comment thread
      description: Every comment on one post, replies nested in children[], paged to completion server-side, with total, truncated and depth_max. Reddit, Hacker News and GitHub issues/PRs; capped at 500 nodes under a 20s budget, and a thread the upstream cannot fully expand says so in truncated and _warnings instead of looking complete. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://news.ycombinator.com/item?id=8863
          description: "The post whose comments you want. Supported: Hacker News item links, Reddit post permalinks, GitHub issue or pull-request URLs."
        - name: max
          in: query
          required: false
          schema:
            type: string
          example: "500"
          description: Maximum comment nodes to return, 1-500 (default 500). The tree is cut depth-first and truncated=true says so.
        - name: replies
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Set false to return only top-level comments (each with an empty children array).
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Accepted for compatibility and ignored — each upstream returns its own comment order and re-sorting a nested tree would misrepresent it.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Accepted for compatibility and ignored — this endpoint pages to completion server-side and returns one whole tree.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/creator-vetting:
    get:
      operationId: panorama_creator_vetting
      tags:
        - Panorama
      summary: Creator vetting
      description: "Vet one creator: profile and reach, recent-output engagement (avg per post, rate vs followers, posting cadence), a comment sample from the top post, and TikTok Shop showcase commerce where it exists. Every number is copied or counted with the formula disclosed — nothing model-scored. Costs 8 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Creator username without the @.
        - name: platform
          in: query
          required: true
          schema:
            type: string
          example: tiktok
          description: tiktok, instagram, youtube, x or threads.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 8
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/crisis-postmortem:
    get:
      operationId: panorama_crisis_postmortem
      tags:
        - Panorama
      summary: Crisis post-mortem timeline
      description: "A who-said-what-first timeline for a brand across the news index, Reddit, Hacker News and web search inside a window: the first credible origin, the peak day, volume by day, first appearance per platform and the ordered items. Costs 30 credits per successful live response."
      parameters:
        - name: brand
          in: query
          required: true
          schema:
            type: string
          example: Monzo
          description: Brand or company
        - name: window_start
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-20"
          description: ISO start of the crisis window (default 14 days before window_end)
        - name: window_end
          in: query
          required: false
          schema:
            type: string
          example: "2026-09-03"
          description: ISO end of the window (default now)
        - name: crisis_terms
          in: query
          required: false
          schema:
            type: string
          example: outage
          description: Comma-separated terms; the first narrows the search
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 30
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/demand-signals:
    get:
      operationId: panorama_demand_signals
      tags:
        - Panorama
      summary: Demand signals
      description: "A consumer-demand nowcast from published inputs: app-review velocity in both stores, news volume, Reddit velocity and the Amazon review-count level, each with its anchor, and a plain-mean index with disclosed weights; never an opaque score. Costs 30 credits per successful live response."
      parameters:
        - name: keyword
          in: query
          required: true
          schema:
            type: string
          example: Monzo
          description: Product, app or brand
        - name: signals
          in: query
          required: false
          schema:
            type: string
          example: app_reviews,news,reddit,amazon
          description: Inputs to read
        - name: app_store_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Skips the App Store lookup
        - name: google_play_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Skips the Play lookup
        - name: amazon_query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Search terms for the Amazon input; defaults to the keyword
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: gb
          description: Storefront for the app stores
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Newest items per input, 10 to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 30
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/devtool-brief:
    get:
      operationId: panorama_devtool_brief
      tags:
        - Panorama
      summary: Devtool brief
      description: "A developer tool in one call: its GitHub repo dossier (repo, README, releases, contributors, top issues) plus the Hacker News reaction and a 7-day commit count — fans out across up to 9 upstream calls, and reports every source that failed inline rather than guessing. Costs 5 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: BurntSushi/ripgrep
          description: "The tool: an owner/repo, a github.com URL, or a plain name (resolved by GitHub repository search)"
        - name: threads
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Hacker News threads to return, ranked by points (1-25, default 10)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/earned-media:
    get:
      operationId: panorama_earned_media
      tags:
        - Panorama
      summary: Earned media
      description: Of everything said about X in the window, how much did X say itself? Mentions split owned vs earned against the handles you declare, with earned share of mentions and engagement, top earned posts as evidence, and per-source coverage. Run it on a monitor for a campaign timeseries. Costs 5 credits per successful live response.
      parameters:
        - name: brand
          in: query
          required: true
          schema:
            type: string
          example: minoapi
          description: Brand, product or campaign phrase to attribute mentions for.
        - name: handles
          in: query
          required: false
          schema:
            type: string
          example: reddit:acme
          description: "Comma list of the brand's OWN accounts, source-scoped or bare: reddit:acme,bluesky:acme.bsky.social,acme. Without it everything counts as earned."
        - name: lookback_days
          in: query
          required: false
          schema:
            type: string
          example: "7"
          description: Window in days (default 30).
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/employer-brand:
    get:
      operationId: panorama_employer_brand
      tags:
        - Panorama
      summary: Employer brand
      description: "What people say about working at a company: the company's own LinkedIn voice beside Reddit, the news index and YouTube, with volumes, engagement and samples per surface and, on request, themed praise and complaints. Costs 30 credits per successful live response."
      parameters:
        - name: company
          in: query
          required: true
          schema:
            type: string
          example: Monzo
          description: Company name
        - name: linkedin_url
          in: query
          required: false
          schema:
            type: string
          example: https://www.linkedin.com/company/monzo-bank/
          description: The company page, for its own voice
        - name: surfaces
          in: query
          required: false
          schema:
            type: string
          example: linkedin,reddit,news,youtube
          description: Surfaces to read
        - name: phrases
          in: query
          required: false
          schema:
            type: string
          example: culture,interview
          description: Comma-separated phrases appended to the company for the outside search
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: themes
          description: "themes: a model pass naming praise and complaints from the outside chatter"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 30
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/handle-audit:
    get:
      operationId: panorama_handle_audit
      tags:
        - Panorama
      summary: Handle audit
      description: "Where a handle exists across the live platforms: taken / free / unknown per platform (a clean 404 counts as FREE — that is an answer), profile links, followers, and the strongest presence. Platforms needing commercial providers are absent, not assumed. Costs 5 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: vercel
          description: The username to audit (with or without @)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/launch-brief:
    get:
      operationId: panorama_launch_brief
      tags:
        - Panorama
      summary: Launch brief
      description: "How a launch landed on Hacker News: the top threads by points with their root comments, plus thread/point/comment totals and the first and last time it was discussed — 1 + N upstream calls; the platforms Monocrawl cannot reach are named in _warnings rather than silently omitted. Costs 5 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: ripgrep
          description: The launch, product or announcement to trace
        - name: threads
          in: query
          required: false
          schema:
            type: string
          example: "5"
          description: Top threads by points to expand (1-10, default 5)
        - name: comments
          in: query
          required: false
          schema:
            type: string
          example: "5"
          description: Root comments to pull per thread (0-20, default 5)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/leads:
    get:
      operationId: panorama_leads
      tags:
        - Panorama
      summary: Switching-intent leads
      description: "Public conversations where people seek alternatives to, compare, or switch from a competitor: three exact-intent phrases through web search plus Reddit and Hacker News, deduplicated and ranked by intent, freshness and engagement, with counts by phrase and platform. Conversation-level only. Costs 30 credits per successful live response."
      parameters:
        - name: competitor
          in: query
          required: true
          schema:
            type: string
          example: Notion
          description: The product people may be leaving
        - name: product_category
          in: query
          required: false
          schema:
            type: string
          example: note-taking app
          description: Narrows the web phrases
        - name: freshness_days
          in: query
          required: false
          schema:
            type: string
          example: "90"
          description: Keep conversations from the last N days, 1 to 365
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Leads to return, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 30
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/lookup:
    get:
      operationId: panorama_lookup
      tags:
        - Panorama
      summary: Universal URL lookup
      description: "Universal URL dispatcher: paste any social, app-store, link-in-bio or web URL and it is parsed and routed to the matching Monocrawl detail endpoint, returning that endpoint's payload verbatim; a URL belonging to a platform we do not serve live is refused by name (it is never quietly scraped instead). Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://github.com/vercel/next.js
          description: "Any public URL: GitHub repo/issue/user, Hacker News item or user, Reddit post/subreddit/user, Bluesky post or profile, App Store app, Apple Music artist/album/song, a Linktree/Linkbio/Linkme/Komi/Pillar page, or any other http(s) page"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/mention-surge:
    get:
      operationId: panorama_mention_surge
      tags:
        - Panorama
      summary: Mention surge
      description: Is a brand's mention velocity abnormal right now? Current mentions/day against a baseline rate, a ratio with stated thresholds (quiet < 1.5 ≤ elevated < 3 ≤ surge), and the evidence driving it. A silent baseline yields no_baseline, not a fabricated ratio. Costs 5 credits per successful live response.
      parameters:
        - name: brand
          in: query
          required: true
          schema:
            type: string
          example: minoapi
          description: The brand or product to watch
        - name: window_days
          in: query
          required: false
          schema:
            type: string
          example: "7"
          description: Current window (default 7)
        - name: baseline_days
          in: query
          required: false
          schema:
            type: string
          example: "28"
          description: Baseline window (default 28; must exceed window_days)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/org-brief:
    get:
      operationId: panorama_org_brief
      tags:
        - Panorama
      summary: Organisation brief
      description: "A GitHub organisation's footprint: its identity, its public repositories, and the top N by stars each expanded into a compact dossier (latest release + README excerpt) — fans out across 2 + 2xN upstream calls with a hard cap of 10 repos. Costs 5 credits per successful live response."
      parameters:
        - name: org
          in: query
          required: true
          schema:
            type: string
          example: vercel
          description: GitHub organisation or user login
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "5"
          description: How many top repos to expand into a compact dossier (1-10, default 5) — this parameter sets the fan-out width
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/post-stats:
    get:
      operationId: panorama_post_stats
      tags:
        - Panorama
      summary: Batch post engagement
      description: Up to 100 mixed-platform post URLs in one call, each answered with current engagement (likes, comments, shares, views, score) and the time it was read. Fans out over hackernews, reddit, bluesky and github, 5 upstreams at a time. Fields a platform does not publish are null, never guessed; unreadable URLs are listed in failed[] with the reason. Costs 5 credits per successful live response.
      parameters:
        - name: urls
          in: query
          required: true
          schema:
            type: string
          example: https://news.ycombinator.com/item?id=8863,https://bsky.app/profile/bsky.app/post/3kabc
          description: "Up to 100 post URLs, comma or newline separated (a JSON array of URL strings also works). Recognised: Hacker News item links, Reddit permalinks and redd.it links, Bluesky post links and at:// URIs, and GitHub issue or pull-request URLs."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/product-reviews:
    get:
      operationId: panorama_product_reviews
      tags:
        - Panorama
      summary: Product reviews across sources
      description: A product's reviews across Amazon, Google Shopping offers and the brand's Trustpilot page, folded into per-source ratings (listed aggregates preferred over sample means), a retailer price matrix, one merged review sample and, on request, a themed topic pass. Costs 30 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: Sony WH-1000XM5
          description: Product name; or pass asin
        - name: asin
          in: query
          required: false
          schema:
            type: string
          example: B09Y2MYL5C
          description: Amazon ASIN or product URL (skips the search)
        - name: brand
          in: query
          required: false
          schema:
            type: string
          example: Sony
          description: Brand for the Trustpilot leg; defaults to the Amazon listing's brand
        - name: trustpilot_domain
          in: query
          required: false
          schema:
            type: string
          example: sony.co.uk
          description: The brand's Trustpilot page domain (skips the Trustpilot search)
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: amazon,google_shopping,trustpilot
          description: Sources to include
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews per source in the sample, 1 to 50
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: topics
          description: "topics: a model pass that groups the sampled reviews by theme (rating impact is recomputed in code)"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 30
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/profiles:
    get:
      operationId: panorama_profiles
      tags:
        - Panorama
      summary: Batch author lookup
      description: Up to 50 (platform, handle) pairs in one call, each resolved into the same canonical author shape (id, handle, name, url, avatar, followers, following, posts_count, bio, platform) with honest nulls. Fans out over github, hackernews, reddit and bluesky, 5 upstreams at a time; every failed pair is reported with its reason in failed[]. Costs 5 credits per successful live response.
      parameters:
        - name: pairs
          in: query
          required: true
          schema:
            type: string
          example: github:torvalds,hackernews:pg,bluesky:bsky.app
          description: "Up to 50 platform:handle pairs, comma or newline separated. A JSON array also works: [{\"platform\":\"github\",\"handle\":\"torvalds\"}] or [\"github:torvalds\"]. Live platforms: github, hackernews, reddit, bluesky — a pair naming any other platform comes back as one failed row, never as a failed call."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/questions:
    get:
      operationId: panorama_questions
      tags:
        - Panorama
      summary: Audience questions
      description: The real questions a topic's audience asks, harvested from Hacker News and Reddit, deduped across sources and ranked by engagement (points/score + comments) — 2 upstream calls, with Reddit tolerated-failing and the question test stated in _warnings; no AI is used anywhere. Costs 5 credits per successful live response.
      parameters:
        - name: topic
          in: query
          required: true
          schema:
            type: string
          example: postgres
          description: The topic whose audience you want to hear from
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Questions to return (1-100, default 25)
        - name: subreddit
          in: query
          required: false
          schema:
            type: string
          example: postgres
          description: Scope the Reddit half of the harvest to one subreddit
        - name: timeframe
          in: query
          required: false
          schema:
            type: string
          example: year
          description: "Reddit timeframe: hour, day, week, month, year or all"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/reputation:
    get:
      operationId: panorama_reputation
      tags:
        - Panorama
      summary: Brand reputation across sources
      description: A brand's reputation across Trustpilot, both app stores, its Google Business listing, TripAdvisor when a place is given and the news echo, blended into a published-weight composite score with company and product axes, per-source ratings and samples, and, on request, themed praise and complaints. Costs 30 credits per successful live response.
      parameters:
        - name: brand
          in: query
          required: true
          schema:
            type: string
          example: Monzo
          description: Brand or company name
        - name: trustpilot_domain
          in: query
          required: false
          schema:
            type: string
          example: monzo.com
          description: The brand's Trustpilot page domain (skips the Trustpilot search)
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: trustpilot,app_store,google_play,google_business,news
          description: Sources to include (tripadvisor when place is set)
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: gb
          description: Storefront country for the app stores
        - name: depth
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews per source in the sample, 1 to 50
        - name: app_store_id
          in: query
          required: false
          schema:
            type: string
          example: "1052238659"
          description: App Store id (skips the app search)
        - name: google_play_id
          in: query
          required: false
          schema:
            type: string
          example: co.uk.getmondo
          description: Play package (skips the app search)
        - name: place
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A TripAdvisor page URL to add as a source
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: themes
          description: "themes: a model pass that names recurring praise and complaints with verbatim quotes"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 30
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/review-integrity:
    get:
      operationId: panorama_review_integrity
      tags:
        - Panorama
      summary: Review integrity
      description: "Do an app's recent reviews look organic, by the numbers: rating distribution, five-star share, text-duplication ratio (3-gram shingles), busiest-day burst ratio, and threshold-crossing signals. Metrics and formulas only — no verdict is rendered. Costs 5 credits per successful live response."
      parameters:
        - name: app_id
          in: query
          required: true
          schema:
            type: string
          example: "324684580"
          description: Numeric App Store track id
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: 2-letter storefront country (default us)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/share-of-voice:
    get:
      operationId: panorama_share_of_voice
      tags:
        - Panorama
      summary: Share of voice
      description: "How 2–5 brands split the conversation across the live sources: mentions, engagement, share of each (formula disclosed), per-source splits and top evidence links. Silence yields null shares, never invented ones. Costs 5 credits per successful live response."
      parameters:
        - name: brands
          in: query
          required: true
          schema:
            type: string
          example: deno,bun
          description: 2–5 comma-separated brand or product names to compare
        - name: lookback_days
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Mention window in days (default 30)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/truthsocial-pulse:
    get:
      operationId: panorama_truthsocial_pulse
      tags:
        - Panorama
      summary: Truth Social pulse
      description: "A Truth Social handle's pulse: profile, activity and engagement from the newest posts, the top posts, and the news echo for the name. Costs 10 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: realDonaldTrump
          description: Truth Social username
        - name: news_query
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Search terms for the news echo; defaults to the display name
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: news
          description: "news (default), tone: a model reading of the sample"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/video-intel:
    get:
      operationId: panorama_video_intel
      tags:
        - Panorama
      summary: Video intelligence
      description: "One video, every angle: the post with its stats, the transcript, the top comments and the author profile — one composite, one call. engagement_rate = interactions ÷ plays, formula disclosed; legs a platform cannot serve are skipped with the reason. Failed legs prorate the price. Costs 8 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/@nasa/video/7665075736742530317
          description: A video/post URL on tiktok, youtube, instagram, x or facebook.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 8
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/panorama/voice:
    get:
      operationId: panorama_voice
      tags:
        - Panorama
      summary: One voice across the microblogs
      description: One person's recent public posts across X, Threads, Bluesky and Truth Social, time-merged into a single feed with platform presence, per-platform cadence and engagement, and the cross-posting rate; absence is part of the answer. Costs 5 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Username shared across the microblogs (Bluesky handles without a dot get .bsky.social)
        - name: platforms
          in: query
          required: false
          schema:
            type: string
          example: x,threads,bluesky,truthsocial
          description: Microblogs to read
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Posts per platform, up to 50
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: tone
          description: "tone: a model pass that labels each platform's tone from the sample"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/pillar/page:
    get:
      operationId: pillar_page
      tags:
        - Pillar
      summary: Pillar page
      description: Creator identity and every outbound link on a public Pillar page. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://pillar.io/example
          description: Full Pillar URL or the bare handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/pinterest/board:
    get:
      operationId: pinterest_board
      tags:
        - Pinterest
      summary: Pinterest board pins
      description: The pins on a board, one page at a time, in the same pin shape as the search route. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.pinterest.com/nasa/space-images/
          description: Board URL
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/pinterest/boards:
    get:
      operationId: pinterest_boards
      tags:
        - Pinterest
      summary: Pinterest boards
      description: "A user's boards: name, URL, description, follower and pin counts, cover and created time. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Pinterest username
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/pinterest/pin:
    get:
      operationId: pinterest_pin
      tags:
        - Pinterest
      summary: Pinterest pin
      description: "One pin: description, alt text, image, created time, save, share and reaction counts, pinner and original pinner. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.pinterest.com/pin/1234567890123456789/
          description: Pin URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/pinterest/search:
    get:
      operationId: pinterest_search
      tags:
        - Pinterest
      summary: Pin search
      description: "Search Pinterest pins by keyword: title, description, image and author. Paged by cursor. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: living room decor
          description: Search term.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/pinterest/url-stats:
    get:
      operationId: pinterest_url_stats
      tags:
        - Pinterest
      summary: Pinterest URL statistics
      description: How many times pages have been pinned on Pinterest. Costs 4 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.bbc.co.uk/food
          description: Up to ten page URLs, comma-separated
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/polymarket/research:
    get:
      operationId: polymarket_research
      tags:
        - Polymarket
      summary: Polymarket market research
      description: "Search Polymarket for active prediction markets on a topic: question, outcomes with live prices, volume, liquidity, and end date, ranked by volume. Costs 5 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: bitcoin
          description: Topic to research
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Max markets, 1-25 (default 10)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/quora/answers:
    get:
      operationId: quora_answers
      tags:
        - Quora
      summary: Quora answers
      description: "The answers on a Quora question page as a list (author, credentials, body, upvotes), with the question's title and total answer count. Quora loads further answers on scroll and offers no page cursor. Costs 2 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.quora.com/What-is-the-best-way-to-learn-Python
          description: Question page URL on quora.com
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/quora/profile:
    get:
      operationId: quora_profile
      tags:
        - Quora
      summary: Quora profile
      description: "A Quora profile (rendered page): name, credential line, description, follower and following counts, answer/question/post counts and the profile picture. Costs 3 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: Guido-van-Rossum
          description: Profile handle (the part after quora.com/profile/) or profile URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/quora/question:
    get:
      operationId: quora_question
      tags:
        - Quora
      summary: Quora question
      description: "A Quora question: title, details, tags, answer/follower/view counts, the answers on the page (author, credentials, body, upvotes) and related questions. Costs 2 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.quora.com/What-is-the-best-way-to-learn-Python
          description: Question page URL on quora.com
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/quora/search:
    get:
      operationId: quora_search
      tags:
        - Quora
      summary: Quora search
      description: "Quora's search results for a query (rendered page): questions, answers, profiles and spaces on the first results page. Costs 3 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: learn python
          description: Search words
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/quora/space:
    get:
      operationId: quora_space
      tags:
        - Quora
      summary: Quora space
      description: "A Quora space (rendered page): name, description, follower count, contributors and the first posts. Costs 3 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: Python-Programming-Language-1
          description: Space handle (the part after quora.com/q/) or space URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/quora/topic:
    get:
      operationId: quora_topic
      tags:
        - Quora
      summary: Quora topic
      description: "A Quora topic (rendered page): name, description, follower count and the first questions. Costs 3 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: Python-programming-language-1
          description: Topic handle (the part after quora.com/topic/) or topic URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/quora/user-posts:
    get:
      operationId: quora_user_posts
      tags:
        - Quora
      summary: Quora user answers
      description: "The first page of a Quora user's answers feed (rendered page): question, answer text, upvotes, date and URL. Costs 3 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: Guido-van-Rossum
          description: Profile handle or profile URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/reddit/omni-search:
    get:
      operationId: reddit_omni_search
      tags:
        - Reddit
      summary: Reddit omni-search
      description: "One keyword swept across Reddit: the matching threads, the top-level comments on each, and the communities they sit in with subscriber and activity figures. Costs 5 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: notion alternatives
          description: Keyword or phrase to sweep across Reddit
        - name: subreddit
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Limit the sweep to one subreddit
        - name: threads
          in: query
          required: false
          schema:
            type: string
          example: "5"
          description: Threads to return, 1 to 10
        - name: comments_per_thread
          in: query
          required: false
          schema:
            type: string
          example: "5"
          description: Top-level comments per thread, 0 to 15
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: comments,subreddits
          description: comments, subreddits, or none
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: relevance
          description: relevance, hot, top, new or comments
        - name: timeframe
          in: query
          required: false
          schema:
            type: string
          example: year
          description: hour, day, week, month, year or all
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/reddit/post:
    get:
      operationId: reddit_post
      tags:
        - Reddit
      summary: Reddit post
      description: Title, author, score, flags and body for a single Reddit post by URL. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.reddit.com/r/Python/comments/1w6latb/it_seems_like_there_was_a_change_for_how_hex/
          description: Full Reddit post URL (permalink, redd.it or gallery link)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/reddit/post-transcript:
    get:
      operationId: reddit_post_transcript
      tags:
        - Reddit
      summary: Video transcript
      description: The spoken words of a Reddit-hosted video as text. transcript is null when the video has no speech — that is the honest answer, not an error. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.reddit.com/r/youseeingthisshit/comments/1oiu9xm/football_nostalgiasaints_punter_head_coach_cant/
          description: Reddit post URL containing a video.
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Transcript language.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/reddit/post/comments:
    get:
      operationId: reddit_post_comments
      tags:
        - Reddit
      summary: Reddit post comments
      description: The comment tree of a Reddit post, flattened with depth and parent ids. The first page is the thread itself (up to 500 comments, 50 levels deep); a cursor resolves the remaining reply stubs, up to 100 a page. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.reddit.com/r/Python/comments/1w6latb/it_seems_like_there_was_a_change_for_how_hex/
          description: Full Reddit post URL (permalink, redd.it or gallery link)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Accepted for reference-catalogue compatibility; the public comments endpoint is single-page
        - name: trim
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: true to truncate comment bodies to 500 characters
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/reddit/search:
    get:
      operationId: reddit_search
      tags:
        - Reddit
      summary: Reddit search
      description: Search posts across all of Reddit by keyword, with sort and time filters. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: customer feedback
          description: Keyword or phrase to search for
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: relevance
          description: relevance, hot, top, new or comments (default relevance)
        - name: timeframe
          in: query
          required: false
          schema:
            type: string
          example: month
          description: hour, day, week, month, year or all
        - name: after
          in: query
          required: false
          schema:
            type: string
          example: t3_1abcd2
          description: Reddit fullname to continue after (alias of cursor)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: t3_1abcd2
          description: Opaque cursor from the previous page
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Results per page, 1-100 (default 25)
        - name: include_body
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: true to include each post's selftext body
        - name: trim
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: true to force selftext bodies off
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/reddit/subreddit:
    get:
      operationId: reddit_subreddit
      tags:
        - Reddit
      summary: Subreddit posts
      description: Hot, new, top or rising posts from a subreddit, with cursor pagination. Costs 1 credit per successful live response.
      parameters:
        - name: subreddit
          in: query
          required: true
          schema:
            type: string
          example: programming
          description: Subreddit name, with or without the r/ prefix
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: hot
          description: "Listing order: hot, new, top or rising (default hot)"
        - name: timeframe
          in: query
          required: false
          schema:
            type: string
          example: week
          description: "Window for sort=top: hour, day, week, month, year or all"
        - name: after
          in: query
          required: false
          schema:
            type: string
          example: t3_1abcd2
          description: Reddit fullname to continue after (alias of cursor)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: t3_1abcd2
          description: Opaque cursor from the previous page
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Posts per page, 1-100 (default 25)
        - name: trim
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: true to omit post selftext bodies
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/reddit/subreddit/details:
    get:
      operationId: reddit_subreddit_details
      tags:
        - Reddit
      summary: Subreddit details
      description: Subscribers, active users, description and metadata for a subreddit. Costs 1 credit per successful live response.
      parameters:
        - name: subreddit
          in: query
          required: false
          schema:
            type: string
          example: programming
          description: Subreddit name, with or without the r/ prefix
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.reddit.com/r/programming/
          description: Any reddit.com subreddit URL (alternative to subreddit)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/reddit/subreddit/search:
    get:
      operationId: reddit_subreddit_search
      tags:
        - Reddit
      summary: Subreddit search
      description: Search posts within a single subreddit by keyword. Costs 1 credit per successful live response.
      parameters:
        - name: subreddit
          in: query
          required: true
          schema:
            type: string
          example: programming
          description: Subreddit to search within (without r/)
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: webassembly
          description: Search text (empty lists recent posts)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: relevance
          description: relevance, hot, top, new or comments
        - name: timeframe
          in: query
          required: false
          schema:
            type: string
          example: month
          description: hour, day, week, month, year or all
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Continue a previous page (after also accepted)
        - name: include_body
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Include post selftext bodies
        - name: trim
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Trim bodies out of the response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/reddit/user:
    get:
      operationId: reddit_user
      tags:
        - Reddit
      summary: Reddit user profile
      description: Karma split, cake day and profile flags for a redditor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: spez
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/research/briefing:
    get:
      operationId: research_briefing
      tags:
        - Research
      summary: Research briefing
      description: "An evidence-grounded research briefing: resolves what you mean (asking when a name has several senses), routes to the sources with the best evidence per credit, reconstructs conversations, separates the subject's own promotion from independent reaction, removes duplicates, and answers with claims that each carry inspectable receipts, confidence and stated limitations. Powered by Mosaic. Costs 10 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: The Fellas
          description: "What to research: a creator, brand, product, project, company, event or topic. Ambiguous names return a CLARIFY outcome (free) listing the senses found."
        - name: entity
          in: query
          required: false
          schema:
            type: string
          example: c1
          description: After a CLARIFY outcome, the candidate id you mean. Only then does a metered leg run.
        - name: entity_type
          in: query
          required: false
          schema:
            type: string
          example: creator_media
          description: "Optional hint: creator_media | developer | brand | product | company | event | community. Otherwise inferred from the evidence."
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: reddit,youtube,x
          description: Override the routed source plan with an explicit comma list.
        - name: exclude
          in: query
          required: false
          schema:
            type: string
          example: tiktok
          description: Sources to leave out of the routed plan.
        - name: max_metered
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Cap on metered legs (0–4, default 2). Metered legs add upstream cost Monocrawl absorbs, so the cap keeps a briefing predictable.
        - name: lookback_days
          in: query
          required: false
          schema:
            type: string
          example: "7"
          description: "Effective window: only evidence from the last N days is treated as current; older items are listed separately."
        - name: timeframe
          in: query
          required: false
          schema:
            type: string
          example: week
          description: hour | day | week | month | year — coarse alternative to lookback_days.
        - name: from_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-01"
          description: ISO lower bound for the window.
        - name: to_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-09-01"
          description: ISO upper bound for the window.
        - name: comments
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: true (default) reconstructs the conversation under the top results where a comment endpoint exists.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/agents:
    get:
      operationId: rightmove_agents
      tags:
        - Rightmove
      summary: Rightmove estate agents
      description: "The estate-agent branches in an area: brand, branch, summary, whether they sell or let, logo and telephone numbers. Costs 2 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Birmingham
          description: A postcode, town or area name; resolved once and remembered (or pass identifier)
        - name: identifier
          in: query
          required: false
          schema:
            type: string
          example: REGION^1036
          description: An area identifier from rightmove/locations
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: "Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40"
        - name: name
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only branches whose name contains this
        - name: branch_type
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The portal's branch type filter
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/locations:
    get:
      operationId: rightmove_locations
      tags:
        - Rightmove
      summary: Rightmove area lookup
      description: The areas the portal knows for a name, each with the identifier the searches and the agents route take (REGION^…, OUTCODE^…, STATION^…). Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: SW3
          description: A postcode, town or area name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/property:
    get:
      operationId: rightmove_property
      tags:
        - Rightmove
      summary: Rightmove property
      description: "One listing's page: title, address, price and qualifier, tenure and charges, council tax, description and key features, the utilities and risks the agent declared, nearest stations, photos, floorplans, EPC, brochures and the agent branch. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "90874980"
          description: The listing number (or pass url, the listing's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The listing's page URL instead of an id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/search-rent:
    get:
      operationId: rightmove_search_rent
      tags:
        - Rightmove
      summary: Rightmove homes to rent
      description: "Homes to rent in an area: address, type, bedrooms, monthly rent and its labels, agent, photos, position and when it was listed; the portal's featured homes beside them. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Manchester
          description: A postcode, town or area name; resolved to the portal's identifier once and remembered (or pass identifier)
        - name: identifier
          in: query
          required: false
          schema:
            type: string
          example: REGION^87490
          description: An area identifier from rightmove/locations
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Results per page, 1 to 100
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: "Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40"
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum monthly rent in pounds
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum monthly rent in pounds
        - name: min_bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum bedrooms
        - name: max_bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum bedrooms
        - name: property_type
          in: query
          required: false
          schema:
            type: string
          example: flat
          description: detached, semi-detached, terraced, flat, bungalow; several separated by commas
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: newest, oldest, highest_price or lowest_price
        - name: keywords
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Words to prioritise, separated by commas
        - name: must_have
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: garden, parking, houseShare, retirement, student; separated by commas
        - name: dont_show
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: houseShare, retirement, student; separated by commas
        - name: furnished
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: furnished, partFurnished, unfurnished; separated by commas
        - name: let_type
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: longTerm or shortTerm
        - name: include_let_agreed
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Include homes already let agreed
        - name: added
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only homes added in the last 1, 3, 7 or 14 days
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/search-sale:
    get:
      operationId: rightmove_search_sale
      tags:
        - Rightmove
      summary: Rightmove homes for sale
      description: "Homes for sale in an area: address, type, bedrooms, price and its label, agent, photos, position and when it was listed; the portal's featured homes beside them. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: SW3
          description: A postcode, town or area name; resolved to the portal's identifier once and remembered (or pass identifier)
        - name: identifier
          in: query
          required: false
          schema:
            type: string
          example: REGION^87490
          description: An area identifier from rightmove/locations
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Results per page, 1 to 100
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: "Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40"
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum asking price in pounds
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum asking price in pounds
        - name: min_bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum bedrooms
        - name: max_bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum bedrooms
        - name: property_type
          in: query
          required: false
          schema:
            type: string
          example: flat,terraced
          description: detached, semi-detached, terraced, flat, bungalow, land, park-home; several separated by commas
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: newest, oldest, highest_price or lowest_price
        - name: keywords
          in: query
          required: false
          schema:
            type: string
          example: garden
          description: Words to prioritise, separated by commas
        - name: must_have
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: garden, parking, newHome, retirement, sharedOwnership, auction; separated by commas
        - name: dont_show
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: newHome, retirement, sharedOwnership, auction; separated by commas
        - name: include_sold
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Include homes sold subject to contract
        - name: added
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only homes added in the last 1, 3, 7 or 14 days
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/similar:
    get:
      operationId: rightmove_similar
      tags:
        - Rightmove
      summary: Rightmove similar homes
      description: "The homes the portal shows as similar to one listing: address, price, bedrooms, type and photos. Costs 2 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "90874980"
          description: The listing number (or pass url, the listing's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The listing's page URL instead of an id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/sold-locations:
    get:
      operationId: rightmove_sold_locations
      tags:
        - Rightmove
      summary: Rightmove sold-prices area lookup
      description: The areas the sold-prices index knows for a name, each with the identifier and type rightmove/sold-prices takes. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: London
          description: A postcode, town or area name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/sold-prices:
    get:
      operationId: rightmove_sold_prices
      tags:
        - Rightmove
      summary: Rightmove sold prices
      description: "Land Registry sales in an area as the portal indexes them: address, type, bedrooms, every recorded sale with its date, price and tenure, and the last sale first. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Beeston, Nottingham
          description: A postcode, town or area name; resolved once and remembered (or pass identifier and type)
        - name: identifier
          in: query
          required: false
          schema:
            type: string
          example: "3205"
          description: An area identifier from rightmove/sold-locations
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: REGION
          description: The identifier's type from rightmove/sold-locations
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (25 a page)
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: "Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40"
        - name: property_type
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: detached, semi_detached, terraced or flat
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: last_sold
          description: last_sold, lowest_price, highest_price or address
        - name: years
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only sales in the last 1, 2, 3, 5, 10, 15, 20 or 30 years
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rightmove/sold-property:
    get:
      operationId: rightmove_sold_property
      tags:
        - Rightmove
      summary: Rightmove sold property
      description: "One sold property's history: every Land Registry sale with the change between them, the data's dates, and the listing the portal keeps beside it with its photos and floorplans. Costs 2 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: c152e439-e184-4300-8e6d-c4736523f835
          description: The sold property's id from a rightmove/sold-prices row (or pass url, its page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The sold property's page URL instead of an id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rumble/channel-videos:
    get:
      operationId: rumble_channel_videos
      tags:
        - Rumble
      summary: Rumble channel videos
      description: A channel's videos, newest first, one page at a time, with the channel's name, URL and handle. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://rumble.com/c/nasa
          description: Channel URL (or pass handle)
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: nasa
          description: Channel handle, instead of url
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rumble/search:
    get:
      operationId: rumble_search
      tags:
        - Rumble
      summary: Rumble search
      description: Videos and shorts matching a query on Rumble, with views, duration, publish time and channel. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: rocket launch
          description: Search query
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rumble/video:
    get:
      operationId: rumble_video
      tags:
        - Rumble
      summary: Rumble video
      description: "One video: title, description, duration, publish time, views, likes and dislikes, channel, embed URL and caption languages. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://rumble.com/v4abcde-example.html
          description: Video URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rumble/video-comments:
    get:
      operationId: rumble_video_comments
      tags:
        - Rumble
      summary: Rumble video comments
      description: "Comments on a video: text, time, likes, dislikes, reply count and author. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://rumble.com/v4abcde-example.html
          description: Video URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/rumble/video-transcript:
    get:
      operationId: rumble_video_transcript
      tags:
        - Rumble
      summary: Rumble video transcript
      description: The transcript of a video, with its language; has_transcript is false when there are no captions. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://rumble.com/v4abcde-example.html
          description: Video URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/search/all:
    get:
      operationId: search_all
      tags:
        - Mosaic
      summary: Cross-platform search
      description: "Cross-platform search as a pipeline: query intent detection, per-source entity resolution (handles are verified before account legs run), fan-out to live sources only, cross-source deduplication, relevance scoring with a floor, and per-source receipts (latency, cost, kept/dropped). A search with nothing relevant returns NO_USEFUL_SIGNAL and charges 0; partial source failures prorate the price. Set estimate=true for a free plan + max-cost preview. Costs 10 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: model context protocol
          description: What to search. Plain topics, "quoted phrases", @handles, owner/repo, domains and URLs are each understood.
        - name: estimate
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: true returns the execution plan and maximum cost without running anything. Free.
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: github,reddit,tiktok
          description: Comma list restricting the fan-out. Default sources (github, hackernews, reddit, bluesky, youtube) run unless excluded; metered sources (tiktok, instagram, linkedin, threads, pinterest, x) run ONLY when named here; free niche lanes (polymarket, google_news) also run only when named. A leg that cannot serve the query kind is skipped with the reason in the receipts. Unknown names are ignored with a warning; 'twitter' is accepted for x.
        - name: exclude
          in: query
          required: false
          schema:
            type: string
          example: bluesky
          description: Comma list of sources to leave out.
        - name: comments
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: true fetches the top comments for the top results, cited per item under top_comments — only from sources with a live comment endpoint (reddit, hackernews, youtube; tiktok/instagram when opted in via sources=). Enrichment receipts land in the enrichment section; failures degrade per item.
        - name: lookback_days
          in: query
          required: false
          schema:
            type: string
          example: "7"
          description: Only results from the last N days, where the source supports it.
        - name: timeframe
          in: query
          required: false
          schema:
            type: string
          example: week
          description: hour | day | week | month | year | all — coarse alternative to lookback_days.
        - name: from_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-01-01"
          description: ISO date lower bound, where the source supports it.
        - name: to_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-03-01"
          description: ISO date upper bound, where the source supports it.
        - name: stream
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: "1 answers text/event-stream: plan, source-started, source-completed, cost and enrichment progress events as legs actually run, then one final result event carrying the exact envelope a plain call returns — same billing, same receipts."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/search/creators:
    get:
      operationId: search_creators
      tags:
        - Mosaic
      summary: Creator search
      description: "Cross-platform creator discovery over TikTok, Instagram and Threads: unified creator cards with reach, verification and per-card evidence (Threads creators are derived from matching posts and cite them). Every leg is metered, so the flagship fair-use ceiling applies; no creators found charges 0 and failed legs prorate. Costs 10 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: barefoot running
          description: Who to look for — a niche, a name, a topic.
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: tiktok,instagram
          description: "Comma list restricting the fan-out: tiktok, instagram, threads (default all three)."
        - name: estimate
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: true returns the plan and maximum cost without running anything. Free.
        - name: stream
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: "1 answers text/event-stream: plan, source-started, source-completed, cost and enrichment progress events as legs actually run, then one final result event carrying the exact envelope a plain call returns — same billing, same receipts."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/search/forums:
    get:
      operationId: search_forums
      tags:
        - Mosaic
      summary: Forum search
      description: Fused forum search across Reddit and Hacker News, merged into one tagged result list. Naver is listed in sources_unavailable pending a keyed official API. Costs 10 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: rust async runtime
          description: Search phrase
        - name: sources
          in: query
          required: false
          schema:
            type: string
          example: reddit,hackernews
          description: Comma list restricting which forums are searched
        - name: exclude
          in: query
          required: false
          schema:
            type: string
          example: hackernews
          description: Comma list of forums to skip
        - name: comments
          in: query
          required: false
          schema:
            type: string
          example: top
          description: Reserved — inline comments are not supported yet
        - name: timeframe
          in: query
          required: false
          schema:
            type: string
          example: week
          description: hour | day | week | month | year | all
        - name: lookback_days
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Only results from the last N days, where the source supports it
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/availability:
    get:
      operationId: sephora_availability
      tags:
        - Sephora
      summary: Sephora store availability
      description: Which stores near a point stock one sku, with distance and in-store availability. Costs 3 credits per successful live response.
      parameters:
        - name: sku_id
          in: query
          required: true
          schema:
            type: string
          example: "2495505"
          description: Sku id from sephora/product
        - name: latitude
          in: query
          required: true
          schema:
            type: string
          example: "41.7887"
          description: Latitude
        - name: longitude
          in: query
          required: true
          schema:
            type: string
          example: "-87.7665"
          description: Longitude
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Miles
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/brand-products:
    get:
      operationId: sephora_brand_products
      tags:
        - Sephora
      summary: Sephora brand products
      description: Products of one brand, sixty per page. Costs 3 credits per successful live response.
      parameters:
        - name: brand
          in: query
          required: true
          schema:
            type: string
          example: gucci
          description: Brand name from sephora/brands
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (60 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: best_selling
          description: best_selling, top_rated, price_low_to_high, price_high_to_low or new
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/brands:
    get:
      operationId: sephora_brands
      tags:
        - Sephora
      summary: Sephora brands
      description: Every brand the storefront lists, with ids and URLs. Costs 1 credit per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/categories:
    get:
      operationId: sephora_categories
      tags:
        - Sephora
      summary: Sephora categories
      description: The storefront's top-level categories with ids for sephora/category. Costs 1 credit per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/category:
    get:
      operationId: sephora_category
      tags:
        - Sephora
      summary: Sephora category products
      description: Products in a category, sixty per page. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: cat130054
          description: Category id from sephora/categories
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (60 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: best_selling
          description: best_selling, top_rated, price_low_to_high, price_high_to_low or new
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/category-tree:
    get:
      operationId: sephora_category_tree
      tags:
        - Sephora
      summary: Sephora category children
      description: The child categories of one category. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: cat160006
          description: Category id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/product:
    get:
      operationId: sephora_product
      tags:
        - Sephora
      summary: Sephora product
      description: "One product: brand, price, rating and review count, loves, description, usage, images and its shade or size variants. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: P427421
          description: Product id (P-number), or the product URL
        - name: sku_id
          in: query
          required: false
          schema:
            type: string
          example: "2025633"
          description: A shade or size sku id
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-US
          description: en-US, en-CA or fr-CA
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/reviews:
    get:
      operationId: sephora_reviews
      tags:
        - Sephora
      summary: Sephora product reviews
      description: Reviews of a product with author, rating, recommendation, verified-purchase badge, photos and helpfulness votes. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: P458747
          description: Product id (P-number)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "6"
          description: Reviews per page, up to 30
        - name: offset
          in: query
          required: false
          schema:
            type: string
          example: "0"
          description: Offset for the next page
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: most_helpful
          description: most_helpful, highest_rating, lowest_rating, oldest or newest
        - name: rating
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only this star rating, 1-5
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/search:
    get:
      operationId: sephora_search
      tags:
        - Sephora
      summary: Sephora product search
      description: Products matching a keyword, sixty per page, with brand, price, rating and badges. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: eyeshadow
          description: Search keyword
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (60 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: best_selling
          description: best_selling, top_rated, price_low_to_high, price_high_to_low or new
        - name: category_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Category id from sephora/categories
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price
        - name: min_rating
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum rating, 1-5
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/similar:
    get:
      operationId: sephora_similar
      tags:
        - Sephora
      summary: Sephora similar products
      description: Products the storefront recommends alongside one product. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: P510799
          description: Product id (P-number)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: How many
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/stores:
    get:
      operationId: sephora_stores
      tags:
        - Sephora
      summary: Sephora stores near a point
      description: Stores near a point with address, phone, hours, pickup and curbside flags. Costs 1 credit per successful live response.
      parameters:
        - name: latitude
          in: query
          required: true
          schema:
            type: string
          example: "37.4419"
          description: Latitude
        - name: longitude
          in: query
          required: true
          schema:
            type: string
          example: "-122.1430"
          description: Longitude
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: "50"
          description: Miles
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/sephora/suggestions:
    get:
      operationId: sephora_suggestions
      tags:
        - Sephora
      summary: Sephora search suggestions
      description: Search suggestions for a partial query, with the product each one leads to and the trending categories. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: eyeshadow
          description: Partial search text
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en-US
          description: en-US, en-CA or fr-CA
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/snapchat/profile:
    get:
      operationId: snapchat_profile
      tags:
        - Snapchat
      summary: Snapchat profile
      description: "A public Snapchat profile: name, bio, avatar, subscriber count, category, website and how many highlights and Spotlights it has. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Snapchat public profile username
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/snapchat/spotlight:
    get:
      operationId: snapchat_spotlight
      tags:
        - Snapchat
      summary: Snapchat Spotlight
      description: "One Spotlight: description, content and thumbnail URLs, duration, upload time, creator and view, share, comment, boost and recommend counts. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYaHNzY2NxbWZ0AZTYE3AmAZTYE2UcAAAAAA
          description: Spotlight URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/snapchat/spotlight-comments:
    get:
      operationId: snapchat_spotlight_comments
      tags:
        - Snapchat
      summary: Snapchat Spotlight comments
      description: Comments on a Spotlight, one page at a time, with author names, times, reply counts and reactions. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.snapchat.com/@lilah4823/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYY2pvZnd0ZXVmAZ8fgG8pAZ8ff-_IAAAAAQ
          description: Spotlight URL
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/soundcloud/artist:
    get:
      operationId: soundcloud_artist
      tags:
        - SoundCloud
      summary: SoundCloud artist
      description: "A SoundCloud profile: name, city and country, description, follower, following, track, playlist and like counts, verification. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Profile permalink (or pass url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://soundcloud.com/nasa
          description: Profile URL, instead of handle
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/soundcloud/artist-tracks:
    get:
      operationId: soundcloud_artist_tracks
      tags:
        - SoundCloud
      summary: SoundCloud artist tracks
      description: A profile's tracks, one page at a time, with plays, likes, comments, reposts, genre, duration and licence. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Profile permalink (or pass url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://soundcloud.com/nasa
          description: Profile URL, instead of handle
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/soundcloud/track:
    get:
      operationId: soundcloud_track
      tags:
        - SoundCloud
      summary: SoundCloud track
      description: "One track: title, artwork, genre, duration, dates, play and engagement counts, licence, label, artist and ISRC. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://soundcloud.com/nasa/example-track
          description: Track URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/spotify/album:
    get:
      operationId: spotify_album
      tags:
        - Spotify
      summary: Get a Spotify album
      description: Look up one Spotify album by id or open.spotify.com URL, including label, copyrights, UPC, and the first page of its track listing. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: 4aawyAB9vmqN3uQ7FjRGTy
          description: Spotify album id (this or url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://open.spotify.com/album/4aawyAB9vmqN3uQ7FjRGTy
          description: "open.spotify.com album URL or spotify:album: URI (this or id)"
        - name: market
          in: query
          required: false
          schema:
            type: string
          example: US
          description: ISO 3166-1 alpha-2 country to scope availability (optional)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/spotify/artist:
    get:
      operationId: spotify_artist
      tags:
        - Spotify
      summary: Artist details
      description: "One Spotify artist: followers, monthly listeners, world rank, top cities, biography and top tracks with play counts. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: 0cGUm45nv7Z6M6qdXYQGTX
          description: Spotify artist id, from spotify/search.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/spotify/playlist:
    get:
      operationId: spotify_playlist
      tags:
        - Spotify
      summary: Spotify playlist
      description: A public playlist with its owner, follower count and a page of tracks with play counts. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: 37i9dQZF1DXcBWIGoYBM5M
          description: Playlist id (or pass url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M
          description: Playlist URL, instead of id
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page of tracks
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/spotify/podcast:
    get:
      operationId: spotify_podcast
      tags:
        - Spotify
      summary: Get a Spotify podcast
      description: "Look up one Spotify podcast (show) by id or open.spotify.com URL: publisher, description, languages, and total episode count. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: 38bS44xjbVVZ3No3ByF1dJ
          description: Spotify show id (this or url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://open.spotify.com/show/38bS44xjbVVZ3No3ByF1dJ
          description: "open.spotify.com show URL or spotify:show: URI (this or id)"
        - name: market
          in: query
          required: false
          schema:
            type: string
          example: US
          description: ISO 3166-1 alpha-2 country; show availability is market-scoped (default US)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/spotify/podcast/episodes:
    get:
      operationId: spotify_podcast_episodes
      tags:
        - Spotify
      summary: List a Spotify podcast's episodes
      description: "List a Spotify podcast's episodes newest-first, paginated: title, description, duration, release date, and audio preview. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: 38bS44xjbVVZ3No3ByF1dJ
          description: Spotify show id (this or url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://open.spotify.com/show/38bS44xjbVVZ3No3ByF1dJ
          description: "open.spotify.com show URL or spotify:show: URI (this or id)"
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Offset for the next page (opaque, from a prior response)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Episodes per page, 1-50 (default 25)
        - name: market
          in: query
          required: false
          schema:
            type: string
          example: US
          description: ISO 3166-1 alpha-2 country; episode availability is market-scoped (default US)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/spotify/search:
    get:
      operationId: spotify_search
      tags:
        - Spotify
      summary: Catalog search
      description: "Search the Spotify catalog: matching artists, tracks, albums and playlists with ids and links. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: daft punk
          description: Artist, track, album or playlist name.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/spotify/track:
    get:
      operationId: spotify_track
      tags:
        - Spotify
      summary: Get a Spotify track
      description: Look up one Spotify track by id or open.spotify.com URL, with ISRC, duration, artists, and album context. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: 11dFghVXANMlKmJXsNCbNl
          description: Spotify track id (this or url)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://open.spotify.com/track/11dFghVXANMlKmJXsNCbNl
          description: "open.spotify.com track URL or spotify:track: URI (this or id)"
        - name: market
          in: query
          required: false
          schema:
            type: string
          example: US
          description: ISO 3166-1 alpha-2 country to scope availability (optional)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/status:
    get:
      operationId: status_index
      tags:
        - Status
      summary: Platform status
      description: "Per-provider health over the last 15 minutes: request counts, error rate, p50/p95 latency and an up/degraded/unknown state per upstream provider. Free — costs 0 credits."
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/target/categories:
    get:
      operationId: target_categories
      tags:
        - Target
      summary: Target categories
      description: Target's top-level category tree with node ids for target/category. Costs 1 credit per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/target/category:
    get:
      operationId: target_category
      tags:
        - Target
      summary: Target category products
      description: Products in a Target category at one store, 24 per page. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: 5xtg6
          description: Category node id from target/categories
        - name: store_id
          in: query
          required: false
          schema:
            type: string
          example: "1771"
          description: Target store id for price and stock
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (24 per page)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/target/product:
    get:
      operationId: target_product
      tags:
        - Target
      summary: Target product
      description: "One Target product: title, brand, price, rating and review statistics, description and bullets, images and videos, category breadcrumbs, variations and return policy. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "90848105"
          description: Target product id (the number after /A- in its URL), or the URL
        - name: store_id
          in: query
          required: false
          schema:
            type: string
          example: "1771"
          description: Target store id for price and stock
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/target/reviews:
    get:
      operationId: target_reviews
      tags:
        - Target
      summary: Target product reviews
      description: Reviews of a Target product, ten per page, with the rating distribution, recommendation rate and photo counts. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "93747936"
          description: Target product id
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "0"
          description: Page number, from 0 (10 per page)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/target/search:
    get:
      operationId: target_search
      tags:
        - Target
      summary: Target product search
      description: Products matching a keyword at one Target store, 24 per page, with price, rating, images and variations. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: pant
          description: Search keyword
        - name: store_id
          in: query
          required: false
          schema:
            type: string
          example: "1771"
          description: Target store id (prices and stock are per store; find one with target/stores)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (24 per page)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/target/stores:
    get:
      operationId: target_stores
      tags:
        - Target
      summary: Target stores near a place
      description: Target stores near a place with store ids, distance, phone, address and today's hours. Costs 1 credit per successful live response.
      parameters:
        - name: place
          in: query
          required: true
          schema:
            type: string
          example: "52404"
          description: City, state, ZIP or address
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/telegram/channel:
    get:
      operationId: telegram_channel
      tags:
        - Telegram
      summary: Telegram channel
      description: "A public channel: name, description, avatar, verification, subscriber and member counts, and photo, video and link counts. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: telegram
          description: Public channel handle without the @
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/telegram/channel-posts:
    get:
      operationId: telegram_channel_posts
      tags:
        - Telegram
      summary: Telegram channel posts
      description: A channel's posts, one page at a time, with text, time, views, reactions and forwards, plus the channel summary. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: telegram
          description: Public channel handle without the @
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/telegram/post:
    get:
      operationId: telegram_post
      tags:
        - Telegram
      summary: Telegram post
      description: "One channel post: text, time, views, reactions, forward origin and media count. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://t.me/telegram/100
          description: Post URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/threads/post:
    get:
      operationId: threads_post
      tags:
        - Threads
      summary: Post details
      description: "One Threads post: text, author, like and reply counts, with a short reply preview. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.threads.net/@zuck/post/C2QBoRaRmR1
          description: Full Threads post URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/threads/post-comments:
    get:
      operationId: threads_post_comments
      tags:
        - Threads
      summary: Threads post replies
      description: "The replies bundled with a Threads post: text, like count, reply count and author, paged. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.threads.net/@zuck/post/C2QBoRaRmR1
          description: Full Threads post URL
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Page cursor from the previous answer
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/threads/profile:
    get:
      operationId: threads_profile
      tags:
        - Threads
      summary: Profile
      description: "A Threads account's public profile: bio, follower count and verification. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: zuck
          description: Threads username without the @.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/threads/search:
    get:
      operationId: threads_search
      tags:
        - Threads
      summary: Post search
      description: "Search Threads posts by keyword: text, author, like and reply counts. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: coffee
          description: Search term.
        - name: start_date
          in: query
          required: false
          schema:
            type: string
          description: Earliest post date, YYYY-MM-DD.
        - name: end_date
          in: query
          required: false
          schema:
            type: string
          description: Latest post date, YYYY-MM-DD.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/threads/search-users:
    get:
      operationId: threads_search_users
      tags:
        - Threads
      summary: Threads user search
      description: "Accounts matching a query on Threads: handle, name, verification and avatar. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Name or handle to search for
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/threads/user-posts:
    get:
      operationId: threads_user_posts
      tags:
        - Threads
      summary: Profile posts
      description: "Recent posts from a Threads account: text, like, reply and repost counts. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: zuck
          description: Threads username without the @.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/collection-videos:
    get:
      operationId: tiktok_collection_videos
      tags:
        - TikTok
      summary: TikTok collection videos
      description: The videos saved to a public collection, one page at a time, with the same video shape as the rest of the TikTok routes. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/@tiktok/collection/favorites-7442134949027351314
          description: Collection URL
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/comment-replies:
    get:
      operationId: tiktok_comment_replies
      tags:
        - TikTok
      summary: Comment replies
      description: The reply thread under one TikTok comment. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: comment_id
          in: query
          required: true
          schema:
            type: string
          example: "7623828115408274207"
          description: Comment id from tiktok/post-comments.
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/@stoolpresidente/video/7623818255903329566
          description: Full TikTok video URL.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/creators-popular:
    get:
      operationId: tiktok_creators_popular
      tags:
        - TikTok
      summary: TikTok popular creators
      description: "Temporarily unavailable (since 4 September 2026): the platform's creator directory is down at its source and this operation answers 503, with nothing charged, until it returns. A ranked page of popular creators from the creator marketplace, filterable by creator and audience country. Costs 1 credit per successful live response."
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Page number from the previous page's cursor
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Ranking to use when supported
        - name: follower_count
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Follower band filter when supported
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Creator country
        - name: audience_country
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Audience country
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/tiktok/effect-videos:
    get:
      operationId: tiktok_effect_videos
      tags:
        - TikTok
      summary: TikTok effect videos
      description: Public videos made with a TikTok effect, with engagement counts and the author on every row. Costs 1 credit per successful live response.
      parameters:
        - name: effect_id
          in: query
          required: true
          schema:
            type: string
          example: "321535"
          description: The effect id
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Page cursor from the previous answer
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Videos per page, up to 30
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/effects:
    get:
      operationId: tiktok_effects
      tags:
        - TikTok
      summary: TikTok effects
      description: "TikTok effects (the camera filters creators apply) by id: name, designer, videos made with it, views and icon. Costs 1 credit per successful live response."
      parameters:
        - name: ids
          in: query
          required: true
          schema:
            type: string
          example: "321535"
          description: One or more effect ids, comma separated, up to ten
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/location:
    get:
      operationId: tiktok_location
      tags:
        - TikTok
      summary: TikTok place
      description: "One place: name, address, city, country, category and coordinates. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "22535865202704586"
          description: Place id from a video's location tag or place URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/location-videos:
    get:
      operationId: tiktok_location_videos
      tags:
        - TikTok
      summary: TikTok place videos
      description: Videos tagged at a place, with captions, counts, authors and sounds; paged by cursor. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "22535865202704586"
          description: Place id from a video's location tag or place URL
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Videos per page, at most 30
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/playlist-videos:
    get:
      operationId: tiktok_playlist_videos
      tags:
        - TikTok
      summary: TikTok playlist videos
      description: "The videos in a TikTok playlist: description, cover, duration, play URL, counts and author, in playlist order. Costs 1 credit per successful live response."
      parameters:
        - name: playlist_id
          in: query
          required: true
          schema:
            type: string
          example: "7681171537575824159"
          description: Playlist id from tiktok/user-playlists, or the playlist URL
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Videos per page, up to 30
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from a previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/post:
    get:
      operationId: tiktok_post
      tags:
        - TikTok
      summary: Video details
      description: "One TikTok video: caption, author, duration and current engagement counts. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/@nasa/video/7665075736742530317
          description: Full TikTok video URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/post-comments:
    get:
      operationId: tiktok_post_comments
      tags:
        - TikTok
      summary: Video comments
      description: Comments on a TikTok video with like and reply counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/@nasa/video/7665075736742530317
          description: Full TikTok video URL.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/post-transcript:
    get:
      operationId: tiktok_post_transcript
      tags:
        - TikTok
      summary: Video transcript
      description: The spoken words of a TikTok video as text. transcript is null when the video has no captions — that is the honest answer, not an error. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/@nasa/video/7665075736742530317
          description: Full TikTok video URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/profile:
    get:
      operationId: tiktok_profile
      tags:
        - TikTok
      summary: TikTok profile
      description: "Public TikTok profile: identity, bio, follower/like/video counts. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: charlidamelio
          description: TikTok username, with or without the leading @.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/profile-region:
    get:
      operationId: tiktok_profile_region
      tags:
        - TikTok
      summary: TikTok account region
      description: The region an account posts from, resolved from the account itself rather than guessed from its content. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: TikTok username without the @
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/profile-videos:
    get:
      operationId: tiktok_profile_videos
      tags:
        - TikTok
      summary: Profile videos
      description: Recent videos for a TikTok account, newest first, with per-video stats. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: TikTok username without the @.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          example: "6659752019493208069"
          description: Numeric TikTok user id, kept as a string. Optional alongside the required handle; can speed up the primary source. This is not a sec_uid.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: latest
          description: latest (newest first, the default) or popular. latest is served by every source; popular is served by the source that can rank by popularity, so a continuation stays on that source.
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: GB
          description: Two-letter country code for the primary source location (default GB). If an account should have videos but returns none, try US or another relevant country. Not a filter on the creator country.
        - name: max_cursor
          in: query
          required: false
          schema:
            type: string
          example: "1734562353000"
          description: Primary-source alias for cursor. Use the previous response cursor unchanged. The canonical cursor parameter takes precedence when both are supplied.
        - name: trim
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: "Boolean: true asks the primary source for its trimmed payload; false asks for the full source payload. The public response remains normalized; this is not an instruction to truncate captions."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/profile/full:
    get:
      operationId: tiktok_profile_full
      tags:
        - TikTok
      summary: TikTok profile with posts (one page)
      description: "A real public profile plus one page of posts/videos, preserving original normalized component fields and source order. HTTP 200 may be partial: inspect complete, partial and legs. Failed profile: no posts requested, zero charge. Failed posts: profile retained and only that successful component charged. Cached components use the public cache-hit price. Computed fields are transparent page arithmetic, not SocialCrawl metric-schema equivalence. Costs 2 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: mrbeast
          description: Public profile identifier. LinkedIn accepts /company/name or /in/name URLs.
        - name: posts
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Desired page size, 1-100. Existing components choose their own page size; the entire single source page is preserved, even if longer or shorter, so no records are skipped between cursors. No automatic extra pages.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque posts_cursor from the previous response; use posts_pagination.next_params to retain all required context. Unsupported component continuation is refused before calls.
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: posts,computed
          description: "CSV: posts and/or computed (default both), or profile alone. Profile is always returned. Computed is arithmetic over this page only, not an AI summary."
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          description: Exact numeric string, optional alongside handle; numeric ID-only profile lookup is not supported.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: latest
          description: latest or popular, forwarded to the videos component.
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: GB
          description: Two-letter source region, forwarded unchanged.
        - name: trim
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Source trimming preference; does not permit the bundle to truncate returned records.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/tiktok/search:
    get:
      operationId: tiktok_search
      tags:
        - TikTok
      summary: Video search
      description: Search TikTok videos by keyword, newest-relevant first, with per-video engagement counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: coffee brewing
          description: Search term.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region code to search from.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: relevance (default) or most-liked.
        - name: date_posted
          in: query
          required: false
          schema:
            type: string
          description: Restrict by post date, e.g. past-week.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/search-hashtag:
    get:
      operationId: tiktok_search_hashtag
      tags:
        - TikTok
      summary: Hashtag search
      description: Videos posted under a TikTok hashtag with engagement counts. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: hashtag
          in: query
          required: true
          schema:
            type: string
          example: coffee
          description: "Hashtag without the #."
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region code to search from.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/search-music:
    get:
      operationId: tiktok_search_music
      tags:
        - TikTok
      summary: TikTok sound search
      description: "TikTok sounds matching a keyword: title, artist, duration, cover, a preview URL and how many videos use each. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: espresso
          description: Search words
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Sounds per page, up to 20
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Page cursor from the previous answer
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/search-top:
    get:
      operationId: tiktok_search_top
      tags:
        - TikTok
      summary: TikTok top results
      description: "The top tab of a TikTok search: the videos TikTok ranks first for a query, as the standard video shape. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: james webb telescope
          description: Search query
        - name: publish_time
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Restrict to a publish window when supported
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Sort order when supported
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/search-users:
    get:
      operationId: tiktok_search_users
      tags:
        - TikTok
      summary: User search
      description: Search TikTok accounts by keyword. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: space
          description: Search term.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/song:
    get:
      operationId: tiktok_song
      tags:
        - TikTok
      summary: Sound details
      description: "One TikTok sound: title, artists, duration and how many videos use it — the id feeds tiktok/song-videos. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "7439295283975702544"
          description: TikTok sound/clip id.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/song-videos:
    get:
      operationId: tiktok_song_videos
      tags:
        - TikTok
      summary: Videos using a sound
      description: Videos that use a specific TikTok sound — sound-trend intelligence. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "7439295283975702544"
          description: TikTok sound/clip id.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/suggestions:
    get:
      operationId: tiktok_suggestions
      tags:
        - TikTok
      summary: TikTok search suggestions
      description: What TikTok suggests as you type a query, in order, with the language and score of each suggestion. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: space
          description: Partial query to complete
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region for the suggestions
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/trending:
    get:
      operationId: tiktok_trending
      tags:
        - TikTok
      summary: Trending feed
      description: TikTok's trending feed for a region — what is going viral right now, with per-video stats. Costs 3 credits per successful live response.
      parameters:
        - name: region
          in: query
          required: true
          schema:
            type: string
          example: US
          description: Two-letter region code.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/user-audience:
    get:
      operationId: tiktok_user_audience
      tags:
        - TikTok
      summary: TikTok audience demographics
      description: "Where an account's audience is: the countries its viewers come from, with counts and percentages. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: TikTok username without the @
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/user-followers:
    get:
      operationId: tiktok_user_followers
      tags:
        - TikTok
      summary: Followers
      description: An account's followers with per-user follower counts. Paged by min_time cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: stoolpresidente
          description: TikTok username without the @ (or pass user_id).
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          description: Numeric user id — alternative to handle.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: min_time value from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/user-following:
    get:
      operationId: tiktok_user_following
      tags:
        - TikTok
      summary: Following
      description: The accounts a TikTok user follows. Paged by min_time cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: stoolpresidente
          description: TikTok username without the @.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: min_time value from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/user-liked-videos:
    get:
      operationId: tiktok_user_liked_videos
      tags:
        - TikTok
      summary: TikTok liked videos
      description: Videos an account has liked, when it shows its likes publicly; empty otherwise. Same video shape as the profile-videos route. Costs 2 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: tiktok
          description: TikTok username without the @ (or pass sec_uid)
        - name: sec_uid
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The account's secUid — alternative to handle
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Videos per page, at most 35
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/user-live:
    get:
      operationId: tiktok_user_live
      tags:
        - TikTok
      summary: TikTok live status
      description: "Whether an account is live right now and, when it is, the room: title, cover, start time and viewer counts. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: TikTok username without the @
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/user-playlists:
    get:
      operationId: tiktok_user_playlists
      tags:
        - TikTok
      summary: TikTok playlists
      description: "The playlists a creator has published: name, video count, cover and URL; paged by cursor. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: tiktok
          description: TikTok username without the @ (or pass sec_uid)
        - name: sec_uid
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The account's secUid — alternative to handle
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Playlists per page, at most 35
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok/user-reposts:
    get:
      operationId: tiktok_user_reposts
      tags:
        - TikTok
      summary: TikTok reposts
      description: Videos an account has reposted, newest first; paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: tiktok
          description: TikTok username without the @ (or pass sec_uid)
        - name: sec_uid
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The account's secUid — alternative to handle
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "30"
          description: Videos per page, at most 35
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok_ads/ad:
    get:
      operationId: tiktok_ads_ad
      tags:
        - TikTok Ads
      summary: Ad details
      description: "One TikTok ad from the creative center: title, advertiser account, objective, landing page, engagement metrics and video where disclosed. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1874784102494897"
          description: Ad id from tiktok_ads/search.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktok_ads/search:
    get:
      operationId: tiktok_ads_search
      tags:
        - TikTok Ads
      summary: Ad search
      description: "Search TikTok's public Ads Library by keyword or advertiser: ad id, advertiser, run dates, audience and spend bands, creative media. Paged by cursor. Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: gymshark
          description: Keyword (or pass advertiser for advertiser-specific results).
        - name: advertiser
          in: query
          required: false
          schema:
            type: string
          example: Gymshark
          description: Advertiser name — resolved through TikTok typeahead first.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktokshop/creator-showcase:
    get:
      operationId: tiktokshop_creator_showcase
      tags:
        - TikTok Shop
      summary: Creator showcase
      description: The products a TikTok creator promotes in their public showcase — creator-commerce intelligence. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: mrtiktokreviews
          description: TikTok username without the @.
        - name: region
          in: query
          required: false
          schema:
            type: string
          description: Two-letter region code.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktokshop/product:
    get:
      operationId: tiktokshop_product
      tags:
        - TikTok Shop
      summary: TikTok Shop product
      description: "One TikTok Shop product: title, price, images, sold count, rating and review count, categories, seller and SKUs. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/shop/pdp/goli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo/1729587769570529799
          description: Product URL
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Storefront region (US is the reliable one today)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktokshop/product-reviews:
    get:
      operationId: tiktokshop_product_reviews
      tags:
        - TikTok Shop
      summary: Product reviews
      description: "Reviews for a TikTok Shop product: rating, text, reviewer, SKU, verified-purchase and incentivized flags, with the product's rating summary. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/shop/pdp/1732195276672373419
          description: Product page URL (or pass product_id).
        - name: product_id
          in: query
          required: false
          schema:
            type: string
          description: Product id — alternative to url.
        - name: region
          in: query
          required: false
          schema:
            type: string
          description: Two-letter region code.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Page number, starting at 1.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktokshop/search:
    get:
      operationId: tiktokshop_search
      tags:
        - TikTok Shop
      summary: Product search
      description: "Search TikTok Shop products: title, image, price, units sold, rating and shop. Paged by page-number cursor. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: shoes
          description: What to search for.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Page number, starting at 1.
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region code.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tiktokshop/shop-products:
    get:
      operationId: tiktokshop_shop_products
      tags:
        - TikTok Shop
      summary: Shop products
      description: Every product a TikTok Shop store lists, with prices, sales counts and ratings. Paged by cursor. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079
          description: TikTok Shop store URL
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: top
          description: top or new_releases (default top)
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: Two-letter region code (default US)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/attraction:
    get:
      operationId: tripadvisor_attraction
      tags:
        - TripAdvisor
      summary: TripAdvisor attraction
      description: "An attraction page in full: rating and review count, ranking in its destination, opening hours, description, address and coordinates, website and phone, photos, nearby places, the rating histogram and the latest reviews. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1451754"
          description: Attraction id (the -d number in its URL) or the page URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/attractions:
    get:
      operationId: tripadvisor_attractions
      tags:
        - TripAdvisor
      summary: TripAdvisor attractions
      description: Attractions in a place, thirty per page, with rating, review count, category, ticket price, badges and photo. Costs 3 credits per successful live response.
      parameters:
        - name: geo_id
          in: query
          required: false
          schema:
            type: string
          example: "1954828"
          description: Place geo id from tripadvisor/autocomplete
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: Walt Disney World
          description: Place name, resolved to a geo id when geo_id is absent
        - name: start_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-01"
          description: Visit start (YYYY-MM-DD); defaults to a week ahead
        - name: end_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-03"
          description: Visit end
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: TRAVELER_FAVORITE_V2
          description: Sort name from a previous response
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 30
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Adults
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/autocomplete:
    get:
      operationId: tripadvisor_autocomplete
      tags:
        - TripAdvisor
      summary: TripAdvisor place typeahead
      description: Places and properties matching a name, with the geo id the hotel, restaurant and attraction searches take. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: London
          description: A place or property name
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/cruise:
    get:
      operationId: tripadvisor_cruise
      tags:
        - TripAdvisor
      summary: Cruise ship
      description: "A cruise ship page: name, image, average rating and review count with the rating histogram, passengers, crew, passenger-to-crew and passenger-to-space ratios, launch year, cabin types and sizes, photo categories, whether itineraries are listed, and the newest reviews on the page. Re-wired 6 Sep 2026 on the platform's own reader (migration 191). Costs 2 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.tripadvisor.com/Cruise_Review-d15691709-Reviews-Pearl_Mist
          description: The ship page URL (Cruise_Review-d<id>-Reviews-<name>). Send this, or ship_id with ship_name.
        - name: ship_id
          in: query
          required: false
          schema:
            type: string
          example: "15691709"
          description: Ship id (the number after d in the page URL, as tripadvisor/cruises gives it)
        - name: ship_name
          in: query
          required: false
          schema:
            type: string
          example: Pearl Mist
          description: The ship name as it appears in the page URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/tripadvisor/cruise-reviews:
    get:
      operationId: tripadvisor_cruise_reviews
      tags:
        - TripAdvisor
      summary: Cruise ship reviews
      description: "Reviews of a cruise ship, five a page, newest first (id, link, title, text, bubble rating, month written, author with location, contributions and helpful votes, photo count), with the ship's total review count, page count, rating histogram and a cursor to the next page. Re-wired 6 Sep 2026 on the platform's own reader (migrations 191 and 194). Costs 2 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.tripadvisor.com/Cruise_Review-d15691709-Reviews-Pearl_Mist
          description: The ship page URL. Send this, or ship_id with ship_name.
        - name: ship_id
          in: query
          required: false
          schema:
            type: string
          example: "15691709"
          description: Ship id (the number after d in the page URL)
        - name: ship_name
          in: query
          required: false
          schema:
            type: string
          example: Pearl Mist
          description: The ship name as it appears in the page URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Page number, five reviews a page (default 1); the previous answer's cursor is the next page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/tripadvisor/cruises:
    get:
      operationId: tripadvisor_cruises
      tags:
        - TripAdvisor
      summary: TripAdvisor cruises
      description: Cruises sailing a region, twenty per page, with ship, line, ports, itinerary, sailings and the ship's rating; without a destination, the list of regions. Costs 1 credit per successful live response.
      parameters:
        - name: destination_id
          in: query
          required: false
          schema:
            type: string
          example: "147237"
          description: Cruise region id (147237 is the Caribbean); the region directory upstream is unreliable, so prefer the id
        - name: destination
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Region name, matched against the directory when it answers
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: popularity
          description: popularity, departure_date, price, length or ship
        - name: month
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Departure month, YYYY-MM
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (20 per page)
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/experience-types:
    get:
      operationId: tripadvisor_experience_types
      tags:
        - TripAdvisor
      summary: TripAdvisor experience types
      description: The experience types a destination offers (Spas & Wellness, Boat Tours & Water Sports, …) with how many attractions fall under each, plus the good-for, duration, traveler-rating and award facets. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Nha Trang
          description: Destination name
        - name: geo_id
          in: query
          required: false
          schema:
            type: string
          example: "293928"
          description: Destination geo id; skips the name lookup
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/hotel:
    get:
      operationId: tripadvisor_hotel
      tags:
        - TripAdvisor
      summary: TripAdvisor hotel
      description: "One hotel's page: rating, review count, city ranking, description, languages, amenities, address, coordinates, neighbourhood, transport and photos. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "23448880"
          description: Hotel id from tripadvisor/hotels, or its page URL
        - name: check_in
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-01"
          description: Check-in date; defaults to a week ahead
        - name: check_out
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-03"
          description: Check-out date
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults per room
        - name: rooms
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Rooms
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/hotels:
    get:
      operationId: tripadvisor_hotels
      tags:
        - TripAdvisor
      summary: TripAdvisor hotels
      description: Hotels in a place for a stay, thirty per page, with rating, review count, nightly price, offer labels, badges and photos. Costs 3 credits per successful live response.
      parameters:
        - name: geo_id
          in: query
          required: false
          schema:
            type: string
          example: "60763"
          description: Place geo id from tripadvisor/autocomplete
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: New York
          description: Place name, resolved to a geo id when geo_id is absent
        - name: check_in
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-01"
          description: Check-in date (YYYY-MM-DD); defaults to a week ahead
        - name: check_out
          in: query
          required: false
          schema:
            type: string
          example: "2026-10-03"
          description: Check-out date
        - name: adults
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Adults per room
        - name: rooms
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Rooms
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: BEST_VALUE
          description: BEST_VALUE, POPULARITY, PRICE_LOW_TO_HIGH or DISTANCE_FROM_CITY_CENTER
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 30
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/location:
    get:
      operationId: tripadvisor_location
      tags:
        - TripAdvisor
      summary: TripAdvisor place
      description: The best TripAdvisor match for a place name, with its page path for the reviews route. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: The Balmoral Edinburgh
          description: Place name
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Edinburgh,Scotland,United Kingdom
          description: Location name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/place:
    get:
      operationId: tripadvisor_place
      tags:
        - TripAdvisor
      summary: TripAdvisor place by URL
      description: "Any TripAdvisor hotel, restaurant or attraction page resolved to its record: the same fields as tripadvisor/hotel, tripadvisor/restaurant or tripadvisor/attraction, with kind saying which. Costs 3 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tripadvisor.com/Restaurant_Review-g1954828-d27717696
          description: A TripAdvisor hotel, restaurant or attraction page URL
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Interface language
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/tripadvisor/restaurant:
    get:
      operationId: tripadvisor_restaurant
      tags:
        - TripAdvisor
      summary: TripAdvisor restaurant
      description: "One restaurant's page: rating, review count, city ranking, cuisines, price range, opening hours, description, address, coordinates, neighbourhood, transport, contact links and photos. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "28627898"
          description: Restaurant id from tripadvisor/restaurants, or its page URL
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Interface language
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/restaurants:
    get:
      operationId: tripadvisor_restaurants
      tags:
        - TripAdvisor
      summary: TripAdvisor restaurants
      description: Restaurants in a place, thirty per page, with rating, review count, price range, cuisines, opening status, photo and ordering link. Costs 3 credits per successful live response.
      parameters:
        - name: geo_id
          in: query
          required: false
          schema:
            type: string
          example: "1954828"
          description: Place geo id from tripadvisor/autocomplete
        - name: query
          in: query
          required: false
          schema:
            type: string
          example: Walt Disney World
          description: Place name, resolved to a geo id when geo_id is absent
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: POPULARITY
          description: POPULARITY, RELEVANCE or FEATURED
        - name: filters
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Filter expression from a previous response
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 30
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Cursor from the previous page
        - name: currency
          in: query
          required: false
          schema:
            type: string
          example: USD
          description: Currency code
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en_US
          description: Language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/reviews:
    get:
      operationId: tripadvisor_reviews
      tags:
        - TripAdvisor
      summary: TripAdvisor reviews
      description: Reviews of a TripAdvisor place with rating, title, text, date and any reply. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.tripadvisor.com/Hotel_Review-g186525-d190819-Reviews-The_Balmoral_Hotel-Edinburgh_Scotland.html
          description: The TripAdvisor page URL or path
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: newest or relevance
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/tripadvisor/search:
    get:
      operationId: tripadvisor_search
      tags:
        - TripAdvisor
      summary: TripAdvisor search
      description: Hotels, restaurants and attractions on TripAdvisor matching a query, with rating and review count. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: hotel Edinburgh
          description: Search terms
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Edinburgh,Scotland,United Kingdom
          description: Location name
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/trustpilot/categories:
    get:
      operationId: trustpilot_categories
      tags:
        - Trustpilot
      summary: Trustpilot category search
      description: Trustpilot categories matching a keyword, with the ids the category routes take. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: bank
          description: Category name or keyword
        - name: locale
          in: query
          required: false
          schema:
            type: string
          example: en-GB
          description: Site locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/trustpilot/category:
    get:
      operationId: trustpilot_category
      tags:
        - Trustpilot
      summary: Trustpilot category
      description: One Trustpilot category with its company count, parent, subcategories and siblings. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: bank
          description: Category id from trustpilot/categories
        - name: locale
          in: query
          required: false
          schema:
            type: string
          example: en-GB
          description: Site locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/trustpilot/category-companies:
    get:
      operationId: trustpilot_category_companies
      tags:
        - Trustpilot
      summary: Trustpilot companies in a category
      description: The companies in a Trustpilot category — ranked, recently reviewed or newest — with rating, review count and location. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: bank
          description: Category id from trustpilot/categories
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: recent
          description: default (ranked), recent (recently reviewed) or newest
        - name: min_rating
          in: query
          required: false
          schema:
            type: string
          example: "4"
          description: any, 3, 4 or 4.5
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: GB
          description: Two-letter country code
        - name: city
          in: query
          required: false
          schema:
            type: string
          example: London
          description: City or postcode
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 20 (ranked list only)
        - name: locale
          in: query
          required: false
          schema:
            type: string
          example: en-GB
          description: Site locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/trustpilot/company:
    get:
      operationId: trustpilot_company
      tags:
        - Trustpilot
      summary: Trustpilot company
      description: "A company's Trustpilot profile by domain: rating, review count, categories and claimed status. Queued task. Costs 5 credits per successful live response."
      parameters:
        - name: domain
          in: query
          required: true
          schema:
            type: string
          example: monzo.com
          description: The company's domain
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/trustpilot/consumer:
    get:
      operationId: trustpilot_consumer
      tags:
        - Trustpilot
      summary: Trustpilot reviewer
      description: "A Trustpilot reviewer's public profile: country, verification, review, like and read counts. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: 57320f590000ff000a1ee003
          description: Reviewer id from a review
        - name: locale
          in: query
          required: false
          schema:
            type: string
          example: en-GB
          description: Site locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/trustpilot/consumer-reviews:
    get:
      operationId: trustpilot_consumer_reviews
      tags:
        - Trustpilot
      summary: Trustpilot reviewer reviews
      description: Every review one Trustpilot reviewer has written, with the company each one is about. Costs 2 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: 57320f590000ff000a1ee003
          description: Reviewer id from a review
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page of 20
        - name: locale
          in: query
          required: false
          schema:
            type: string
          example: en-GB
          description: Site locale
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/trustpilot/reviews:
    get:
      operationId: trustpilot_reviews
      tags:
        - Trustpilot
      summary: Trustpilot reviews
      description: Reviews of a company on Trustpilot with rating, title, text, date, reviewer location and any company reply. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: domain
          in: query
          required: true
          schema:
            type: string
          example: monzo.com
          description: The company's domain
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: recency
          description: recency or relevance
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Reviews, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/trustpilot/search:
    get:
      operationId: trustpilot_search
      tags:
        - Trustpilot
      summary: Trustpilot business search
      description: Businesses on Trustpilot matching a query with domain, rating, review count and categories. Queued task. Costs 5 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: monzo
          description: Business name or keywords
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "20"
          description: Results, up to 100
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/truthsocial/post:
    get:
      operationId: truthsocial_post
      tags:
        - Truth Social
      summary: Truth Social post
      description: One post with its counts and its author's profile. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://truthsocial.com/@realDonaldTrump/posts/110000000000000000
          description: Post URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/truthsocial/posts:
    get:
      operationId: truthsocial_posts
      tags:
        - Truth Social
      summary: Truth Social posts
      description: A user's posts, newest first, one page at a time, with reply, reblog, favourite, upvote and downvote counts. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: realDonaldTrump
          description: Username (or pass user_id)
        - name: user_id
          in: query
          required: false
          schema:
            type: string
          example: "107780257626128497"
          description: Account id, instead of handle
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/truthsocial/profile:
    get:
      operationId: truthsocial_profile
      tags:
        - Truth Social
      summary: Profile
      description: "A Truth Social account's public profile: followers, post count, verification and bio. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: realDonaldTrump
          description: Truth Social username without the @.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/twitch/clip:
    get:
      operationId: twitch_clip
      tags:
        - Twitch
      summary: Twitch clip
      description: "Fetch a single Twitch clip from its URL: title, broadcaster, creator, game, duration, view count and thumbnail. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://clips.twitch.tv/AwkwardHelplessSalamanderSwiftRage
          description: Twitch clip URL (clips.twitch.tv/<slug>, twitch.tv/<channel>/clip/<slug>) or a bare clip slug
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/twitch/profile:
    get:
      operationId: twitch_profile
      tags:
        - Twitch
      summary: Channel profile
      description: "A Twitch channel: followers, partner status, live state and current viewers. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: ishowspeed
          description: Twitch login name.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/twitch/user/schedule:
    get:
      operationId: twitch_user_schedule
      tags:
        - Twitch
      summary: Twitch stream schedule
      description: "Get a Twitch channel's upcoming stream schedule: segments with start/end times, category and recurrence, plus any active vacation window. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: twitchdev
          description: Twitch login name (the channel username)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/twitch/user/videos:
    get:
      operationId: twitch_user_videos
      tags:
        - Twitch
      summary: Twitch user videos
      description: List a Twitch channel's videos (VODs, uploads, highlights) with view counts and durations; paginates with an opaque cursor. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: twitchdev
          description: Twitch login name (the channel username)
        - name: filter_by
          in: query
          required: false
          schema:
            type: string
          example: archive
          description: "Video type: all (default), upload, archive, highlight"
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: time
          description: "Sort order: time (default), trending, views"
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Videos per page, 1-100 (default 25)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque pagination cursor from a previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/utility/endpoint:
    get:
      operationId: utility_endpoint
      tags:
        - Utility
      summary: Endpoint documentation
      description: Full documentation for one endpoint — parameters, credit cost, auth header, and a ready-to-paste curl example. Free — costs 0 credits.
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
          example: github/user
          description: Endpoint id as platform/endpoint (or a /v1 path)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.monocrawl.com/v1/github/user
          description: Full endpoint URL as an alternative to id
        - name: method
          in: query
          required: false
          schema:
            type: string
          example: GET
          description: Ignored — all Monocrawl endpoints are GET
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/utility/endpoints:
    get:
      operationId: utility_endpoints
      tags:
        - Utility
      summary: Endpoint catalogue
      description: "The live endpoint catalogue: every callable endpoint with its credit cost, parameters and description. Filter by platform, free-text search, or method. Free — costs 0 credits."
      parameters:
        - name: platform
          in: query
          required: false
          schema:
            type: string
          example: reddit
          description: Only endpoints for this platform
        - name: search
          in: query
          required: false
          schema:
            type: string
          example: comments
          description: Case-insensitive text match on id, name and description
        - name: method
          in: query
          required: false
          schema:
            type: string
          example: GET
          description: HTTP method filter (all Monocrawl endpoints are GET)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/utility/llms:
    get:
      operationId: utility_llms
      tags:
        - Utility
      summary: LLM context payload
      description: "Agent-ready context payload: base URL, auth header, envelope and error model, plus the compact endpoint catalogue grouped by platform. Free — costs 0 credits."
      parameters:
        - name: platform
          in: query
          required: false
          schema:
            type: string
          example: reddit
          description: Limit the catalogue to one platform
        - name: format
          in: query
          required: false
          schema:
            type: string
          example: markdown
          description: markdown (default) or json
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/utility/quickstart:
    get:
      operationId: utility_quickstart
      tags:
        - Utility
      summary: Quickstart
      description: "Get started in one call: the cheapest live endpoint for a platform, a copy-paste curl, and a sketch of the response envelope you will get back. Free — costs 0 credits."
      parameters:
        - name: platform
          in: query
          required: false
          schema:
            type: string
          example: reddit
          description: Platform to start with; omit for the cheapest live endpoint overall
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/walmart/category:
    get:
      operationId: walmart_category
      tags:
        - Walmart
      summary: Walmart category products
      description: Products listed in a Walmart category with price, rating, review count, image, availability and seller, paged. Costs 3 credits per successful live response.
      parameters:
        - name: category_id
          in: query
          required: true
          schema:
            type: string
          example: "3944"
          description: A Walmart category id
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: best_match
          description: best_match, price_low, price_high, best_seller or top_rated
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum price
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum price
        - name: zip_code
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: ZIP code for local availability
        - name: store_id
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Store id
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: us or ca
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/walmart/offers:
    get:
      operationId: walmart_offers
      tags:
        - Walmart
      summary: Walmart offers
      description: "Every seller offering a Walmart item: seller, price, stock, condition, shipping and pickup, return policy. Costs 1 credit per successful live response."
      parameters:
        - name: product_id
          in: query
          required: true
          schema:
            type: string
          example: "609040889"
          description: A Walmart item id or product URL
        - name: country
          in: query
          required: false
          schema:
            type: string
          example: us
          description: us or ca
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/walmart/product:
    get:
      operationId: walmart_product
      tags:
        - Walmart
      summary: Walmart product
      description: "One Walmart product: title, brand, price and savings, rating and review counts, seller, category path, description, highlights, specifications and images. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "6138924168"
          description: Walmart item id (the number after /ip/ in its URL), or the URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/walmart/reviews:
    get:
      operationId: walmart_reviews
      tags:
        - Walmart
      summary: Walmart product reviews
      description: Reviews of a Walmart product, ten per page, with the rating distribution. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "265952442"
          description: Walmart item id
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (10 per page)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/walmart/rollbacks:
    get:
      operationId: walmart_rollbacks
      tags:
        - Walmart
      summary: Walmart rollbacks
      description: Products currently on rollback (marked-down) at Walmart, with the old and new prices. Costs 2 credits per successful live response.
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (about 40 per page)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/walmart/search:
    get:
      operationId: walmart_search
      tags:
        - Walmart
      summary: Walmart product search
      description: Products matching a keyword, forty per page, with price, rating, seller and availability. Costs 3 credits per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: mobile
          description: Search keyword
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (40 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: best_match
          description: best_match, price_low, price_high or best_seller
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/walmart/seller:
    get:
      operationId: walmart_seller
      tags:
        - Walmart
      summary: Walmart seller
      description: "One Walmart marketplace seller: contact details, address, rating summary and distribution. Costs 1 credit per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "8026"
          description: Catalog seller id from a product
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/walmart/seller-reviews:
    get:
      operationId: walmart_seller_reviews
      tags:
        - Walmart
      summary: Walmart seller reviews
      description: Reviews of a Walmart marketplace seller, ten per page, each naming the product bought. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "8026"
          description: Catalog seller id from a product
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (10 per page)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/wayfair/product:
    get:
      operationId: wayfair_product
      tags:
        - Wayfair
      summary: Wayfair product
      description: "One product page: brand, description, price, stock, rating and histogram, question count, documents, options, specifications and the first reviews. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: W003078383
          description: Wayfair SKU, or the product URL
        - name: domain
          in: query
          required: false
          schema:
            type: string
          example: com
          description: "Storefront: com, ca, co.uk or de"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/wayfair/reviews:
    get:
      operationId: wayfair_reviews
      tags:
        - Wayfair
      summary: Wayfair product reviews
      description: "Shopper reviews of a product: rating, text, date, verified buyer and photos. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: W003078383
          description: Wayfair SKU, or the product URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: relevance
          description: relevance, date or rating
        - name: star
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Keep one star rating only
        - name: domain
          in: query
          required: false
          schema:
            type: string
          example: com
          description: "Storefront: com, ca, co.uk or de"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/wayfair/search:
    get:
      operationId: wayfair_search
      tags:
        - Wayfair
      summary: Wayfair product search
      description: "One page of Wayfair products for a keyword or a category: brand, sku, price, discount, rating, options and image. Slow upstream (a full page render). Costs 3 credits per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: bed
          description: Search keyword (or pass url, a Wayfair category URL)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: A Wayfair category URL instead of a keyword
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/agent:
    get:
      operationId: web_agent
      tags:
        - Web Scraping
      summary: Browser agent
      description: "Start an asynchronous browser agent: a hosted browser opens the page and the platform's model chooses navigate, click, type or done for up to eight steps. Returns a job; poll /v1/web/jobs/{job_id} for the final page, the extracted answer and every step taken. Costs 10 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.gov.uk/bank-holidays
          description: Page to start from (http/https)
        - name: prompt
          in: query
          required: true
          schema:
            type: string
          example: Find the date of the next bank holiday in England and Wales
          description: What the agent should do or find (up to 2,000 characters)
        - name: max_steps
          in: query
          required: false
          schema:
            type: string
          example: "6"
          description: Most actions to take, 1 to 8 (default 8)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/web/batch-scrape:
    get:
      operationId: web_batch_scrape
      tags:
        - Web Scraping
      summary: Start an async batch scrape
      description: Scrape up to 25 URLs in one background job and get a job id back immediately; individual URL failures are reported per item and never fail the batch. Costs 3 credits per successful live response.
      parameters:
        - name: urls
          in: query
          required: true
          schema:
            type: string
          example: https://example.com,https://www.iana.org
          description: Comma-separated list or JSON array of URLs to scrape (max 25 per job)
        - name: formats
          in: query
          required: false
          schema:
            type: string
          example: markdown
          description: Comma-separated subset of markdown,text,links (default markdown)
        - name: only_main_content
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Render only the main content region of each page (default true)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/crawl:
    get:
      operationId: web_crawl
      tags:
        - Web Scraping
      summary: Start an async web crawl
      description: Start a breadth-first same-site crawl and get a job id back immediately; poll /v1/web/jobs/{job_id} for the collected pages (url, title, markdown excerpt, status). Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://example.com
          description: Seed URL to crawl (http/https, public hosts only)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Maximum pages to fetch (default 10, cap 50)
        - name: max_depth
          in: query
          required: false
          schema:
            type: string
          example: "2"
          description: Link hops from the seed page (default 2, cap 3)
        - name: include_paths
          in: query
          required: false
          schema:
            type: string
          example: ^/blog/.*
          description: Comma-separated glob patterns; a discovered path must match at least one. * matches any characters, ^ and $ anchor, everything else is literal
        - name: exclude_paths
          in: query
          required: false
          schema:
            type: string
          example: /tag/*,/author/*
          description: Comma-separated glob patterns; a discovered path matching any of them is skipped
        - name: formats
          in: query
          required: false
          schema:
            type: string
          example: markdown
          description: Comma-separated subset of markdown,text,links (default markdown)
        - name: only_main_content
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Render only the main content region of each page (default true)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/extract:
    get:
      operationId: web_extract
      tags:
        - Web Scraping
      summary: Extract structured data from a web page
      description: "Deterministic structured extraction from a public page: meta/Open Graph/Twitter tags, parsed JSON-LD blocks, canonical URL, feeds, and heading outline — no AI involved. Costs 2 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://example.com
          description: Page URL to extract from (http/https, public hosts only)
        - name: timeout
          in: query
          required: false
          schema:
            type: string
          example: "10000"
          description: Fetch budget in milliseconds, clamped to 1000-15000
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/jobs:
    get:
      operationId: web_jobs
      tags:
        - Web Scraping
      summary: List async web jobs
      description: List your asynchronous jobs, newest first, with keyset pagination. Free. Free — costs 0 credits.
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Jobs per page (default 25, cap 100)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page; omit for the first page
        - name: status
          in: query
          required: false
          schema:
            type: string
          example: completed
          description: "Filter by status: queued, running, completed, failed, cancelled (comma-separated for several)"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/jobs/cancel:
    get:
      operationId: web_jobs_cancel
      tags:
        - Web Scraping
      summary: Cancel a job
      description: Cancel one of your queued or running jobs. A queued job is refunded in full; a running job stops but its charge stands, because upstream work had already begun. Free — costs 0 credits.
      parameters:
        - name: job_id
          in: query
          required: true
          schema:
            type: string
          example: job_0123456789abcdef01234567
          description: Job id returned by /v1/web/crawl or /v1/web/batch-scrape
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/jobs/get:
    get:
      operationId: web_jobs_get
      tags:
        - Web Scraping
      summary: Get an async web job
      description: "Fetch one of your jobs by id: status, progress, the result payload once it completes, and the error if it failed. Free. Free — costs 0 credits."
      parameters:
        - name: job_id
          in: query
          required: true
          schema:
            type: string
          example: job_0123456789abcdef01234567
          description: Job id returned by /v1/web/crawl or /v1/web/batch-scrape
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/map:
    get:
      operationId: web_map
      tags:
        - Web Scraping
      summary: Map URLs on a site
      description: Discover a site's URLs from its sitemap.xml (one level of sitemap indexes) with same-origin page links as fallback. Costs 3 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://example.com
          description: Site URL to map (http/https, public hosts only)
        - name: search
          in: query
          required: false
          schema:
            type: string
          example: blog
          description: Only return URLs containing this text (case-insensitive)
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "100"
          description: Maximum URLs to return (default 100, cap 500)
        - name: sitemap
          in: query
          required: false
          schema:
            type: string
          example: include
          description: "Sitemap use: include (default: sitemap first, page links as fallback), only, or skip"
        - name: include_subdomains
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Also include URLs on subdomains of the site
        - name: ignore_query_parameters
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Strip query strings before deduplicating URLs
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/parse:
    get:
      operationId: web_parse
      tags:
        - Web Scraping
      summary: Parse a document
      description: "Fetch a document by URL and extract its text and metadata: PDF (page count, title/author, text from uncompressed and FlateDecode streams), HTML, plain text, Markdown, CSV/TSV (columns, row count, sample rows), JSON (top-level shape) and XML. Returns text = null with a stated reason for encrypted, scanned or image-only PDFs rather than inventing content; Office formats, images and archives are refused with a 422 naming the supported list. Costs 2 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
          description: "URL of the document to parse (http/https, public hosts only). Supported: PDF, HTML, plain text, Markdown, CSV/TSV, JSON, XML."
        - name: timeout
          in: query
          required: false
          schema:
            type: string
          example: "10000"
          description: Fetch budget in milliseconds, clamped to 1000-15000
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/scrape:
    get:
      operationId: web_scrape
      tags:
        - Web Scraping
      summary: Scrape a web page
      description: Fetch a public web page and return its content as markdown, text, raw HTML, links, and/or page metadata. Costs 2 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://example.com
          description: Page URL to scrape (http/https, public hosts only)
        - name: formats
          in: query
          required: false
          schema:
            type: string
          example: markdown,metadata
          description: Comma-separated subset of markdown,html,text,links,metadata (default markdown,metadata)
        - name: only_main_content
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: Strip page chrome (nav/header/footer/aside) and return the main content region (default true)
        - name: timeout
          in: query
          required: false
          schema:
            type: string
          example: "10000"
          description: Fetch budget in milliseconds, clamped to 1000-15000
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/web/sessions:
    get:
      operationId: web_sessions
      tags:
        - Web Scraping
      summary: List browser sessions
      description: "Your browser sessions, newest first, with a cursor to the next page. Expired sessions are marked as they are listed. Free — costs 0 credits. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Sessions per page (default 25, cap 100)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: "1757100000000"
          description: Opaque cursor from the previous page
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/web/sessions/close:
    get:
      operationId: web_sessions_close
      tags:
        - Web Scraping
      summary: Close a browser session
      description: "Release the hosted browser and mark the session closed. Closing early does not refund the hold. Free — costs 0 credits. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: session_id
          in: query
          required: true
          schema:
            type: string
          example: ws_k3j2h1g0abcd
          description: Session id returned by web/sessions/create
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/web/sessions/create:
    get:
      operationId: web_sessions_create
      tags:
        - Web Scraping
      summary: Open a browser session
      description: "Open an interactive hosted browser session: returns the session id, status, expiry, credits held (billed at creation) and a viewer URL. Drive it with web/sessions/execute; close it with web/sessions/close. Costs 5 credits per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://example.com
          description: Page to open first (http/https)
        - name: ttl_seconds
          in: query
          required: false
          schema:
            type: string
          example: "300"
          description: Session lifetime, 30 to 3600 seconds (default 300)
        - name: activity_ttl_seconds
          in: query
          required: false
          schema:
            type: string
          example: "120"
          description: Close after this many idle seconds (optional)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/web/sessions/execute:
    get:
      operationId: web_sessions_execute
      tags:
        - Web Scraping
      summary: Run code in a browser session
      description: "Evaluate JavaScript in the session's page, optionally after navigating: success flag, the returned value, any thrown error, the page URL and the duration. Costs 1 credit per successful live response. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: session_id
          in: query
          required: true
          schema:
            type: string
          example: ws_k3j2h1g0abcd
          description: Session id returned by web/sessions/create
        - name: code
          in: query
          required: true
          schema:
            type: string
          example: document.title
          description: JavaScript evaluated in the page (a promise is awaited); the value is returned as JSON
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://example.com
          description: Navigate here first (optional)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: javascript
          description: "Only javascript: code runs in the page over DevTools, not node, python or bash on a host"
        - name: timeout
          in: query
          required: false
          schema:
            type: string
          example: "10000"
          description: Milliseconds to allow, 1000 to 30000 (default 10000)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/web/sessions/get:
    get:
      operationId: web_sessions_get
      tags:
        - Web Scraping
      summary: Browser session status
      description: "One browser session: status, expiry, credits held and billed, viewer URL, and the supplier's live status while active. Free — costs 0 credits. Not available on production `/v1` at present: no supplier is cleared to serve it there, so this path returns `501 ENDPOINT_NOT_AVAILABLE` and charges nothing. The corresponding `/sandbox` path can return a representative, free response marked `synthetic: true`."
      parameters:
        - name: session_id
          in: query
          required: true
          schema:
            type: string
          example: ws_k3j2h1g0abcd
          description: Session id returned by web/sessions/create
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 0
      x-production-available: false
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/web/social-profiles:
    get:
      operationId: web_social_profiles
      tags:
        - Web Scraping
      summary: Social profile discovery
      description: Starting from one known profile, the same person or brand's profiles on other platforms, with a confidence score and the evidence behind each match, plus link-in-bio and website URLs. Costs 10 credits per successful live response.
      parameters:
        - name: platform
          in: query
          required: true
          schema:
            type: string
          example: instagram
          description: Platform of the known profile
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: Handle on that platform
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 10
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/community:
    get:
      operationId: x_community
      tags:
        - X
      summary: Community
      description: "One X community: name, description, member count and rules. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://x.com/i/communities/1926186499399139650
          description: Full x.com community URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/community-tweets:
    get:
      operationId: x_community_tweets
      tags:
        - X
      summary: Community tweets
      description: Recent tweets inside an X community with authors and engagement counts. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://x.com/i/communities/1926186499399139650
          description: Full x.com community URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/following:
    get:
      operationId: x_following
      tags:
        - X
      summary: Following
      description: The accounts an X account follows, as profile cards — handle, name, bio, location, follower/following/post counts, join date, avatar — up to 200 a page with cursor pagination. Costs 3 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: monzo
          description: X username without the @.
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "200"
          description: Accounts per page, 20–200 (default 200). Smaller pages cost the upstream MORE per account, not less.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/mentions:
    get:
      operationId: x_mentions
      tags:
        - X
      summary: Mentions
      description: "Public X posts that mention an account, newest first, 20 a page: each as a full post card with its author, counts, media and links, with cursor pagination and an optional date window. Costs 3 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: monzo
          description: X username without the @.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
        - name: from_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-01"
          description: ISO date lower bound on post time.
        - name: to_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-09-01"
          description: ISO date upper bound on post time.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/profile:
    get:
      operationId: x_profile
      tags:
        - X
      summary: Profile
      description: "An X account's public profile: bio, follower and post counts, blue-verification. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: X username without the @.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/profile/full:
    get:
      operationId: x_profile_full
      tags:
        - X
      summary: X profile with posts (one page)
      description: "A real public profile plus one page of posts/videos, preserving original normalized component fields and source order. HTTP 200 may be partial: inspect complete, partial and legs. Failed profile: no posts requested, zero charge. Failed posts: profile retained and only that successful component charged. Cached components use the public cache-hit price. Computed fields are transparent page arithmetic, not SocialCrawl metric-schema equivalence. Costs 2 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: NASA
          description: Public profile identifier. LinkedIn accepts /company/name or /in/name URLs.
        - name: posts
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Desired page size, 1-100. Existing components choose their own page size; the entire single source page is preserved, even if longer or shorter, so no records are skipped between cursors. No automatic extra pages.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque posts_cursor from the previous response; use posts_pagination.next_params to retain all required context. Unsupported component continuation is refused before calls.
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: posts,computed
          description: "CSV: posts and/or computed (default both), or profile alone. Profile is always returned. Computed is arithmetic over this page only, not an AI summary."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/x/quotes:
    get:
      operationId: x_quotes
      tags:
        - X
      summary: Quote posts
      description: "The posts that quote a public X post, newest first, 20 a page: each as a full post card with quoted_tweet_id set, its author and counts, with cursor pagination and an optional date window. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1876576540177105257"
          description: Numeric post id. Pass url instead if you only have the link.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://x.com/monzo/status/1876576540177105257
          description: An x.com or twitter.com status link; the id is read from it locally.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
        - name: from_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-01"
          description: ISO date lower bound on quote time.
        - name: to_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-09-01"
          description: ISO date upper bound on quote time.
        - name: include_replies
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: false to leave out quotes that are themselves replies. Default true.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/retweeters:
    get:
      operationId: x_retweeters
      tags:
        - X
      summary: Retweeters
      description: The accounts that reposted a public X post, as profile cards with follower counts and join dates, with cursor pagination. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1876576540177105257"
          description: Numeric post id. Pass url instead if you only have the link.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://x.com/monzo/status/1876576540177105257
          description: An x.com or twitter.com status link; the id is read from it locally.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/search-tweets:
    get:
      operationId: x_search_tweets
      tags:
        - X
      summary: Search posts
      description: "Keyword search over public X posts, newest or top first: text, author card, like/repost/reply/quote/view counts, media, hashtags, mentions and links — 20 posts a page with cursor pagination. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Monzo bank
          description: "Search terms. X's advanced operators work: from:handle, to:handle, lang:en, min_faves:100, \"exact phrase\", -word."
        - name: mode
          in: query
          required: false
          schema:
            type: string
          example: latest
          description: latest (default) for newest first, top for X's relevance ranking.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
        - name: from_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-01"
          description: ISO date lower bound (translated to X's since_time operator).
        - name: to_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-09-01"
          description: ISO date upper bound (translated to X's until_time operator).
        - name: include_reposts
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: true to include reposts. Default leaves them out so a page is 20 original posts.
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: latest
          description: "Alias for mode: latest or top. mode takes precedence; otherwise sort takes precedence over sort_by. Equivalent spellings share the response cache."
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          example: top
          description: "Alias for mode: latest or top. mode, then sort, take precedence. Equivalent spellings share the response cache."
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/tweet:
    get:
      operationId: x_tweet
      tags:
        - X
      summary: Post details
      description: "One X post: text, author and current engagement counts. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://x.com/nasa/status/2095621168208248911
          description: Full X post URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/tweet-replies:
    get:
      operationId: x_tweet_replies
      tags:
        - X
      summary: Post replies
      description: "The replies under a public X post, newest first, 20 a page: each reply as a full post card with its author, counts and in_reply_to_id / conversation_id so threads can be rebuilt. Costs 5 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "1876576540177105257"
          description: Numeric post id. Pass url instead if you only have the link.
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://x.com/monzo/status/1876576540177105257
          description: An x.com or twitter.com status link; the id is read from it locally.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
        - name: from_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-08-01"
          description: ISO date lower bound on reply time.
        - name: to_date
          in: query
          required: false
          schema:
            type: string
          example: "2026-09-01"
          description: ISO date upper bound on reply time.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/tweet-transcript:
    get:
      operationId: x_tweet_transcript
      tags:
        - X
      summary: Video transcript
      description: The spoken words of a video in an X post as text. transcript is null when the video has no speech or captions — that is the honest answer, not an error. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://x.com/TheoVon/status/1916982720317821050
          description: Full X post URL containing a video under ~2 minutes.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/tweets:
    get:
      operationId: x_tweets
      tags:
        - X
      summary: Recent posts
      description: Recent posts for an X account with like, repost, reply and view counts. Costs 1 credit per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: nasa
          description: X username without the @.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/user-followers:
    get:
      operationId: x_user_followers
      tags:
        - X
      summary: Followers
      description: An X account's followers as profile cards — handle, name, bio, location, follower/following/post counts, join date, avatar — up to 200 a page with cursor pagination. Costs 3 credits per successful live response.
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: monzo
          description: X username without the @.
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "200"
          description: Followers per page, 20–200 (default 200). Smaller pages cost the upstream MORE per follower, not less.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/user-media:
    get:
      operationId: x_user_media
      tags:
        - X
      summary: Media posts
      description: "An X account's own posts that carry photos or video (replies left out), newest first: each as a full post card with its media urls, counts and author. A page covers 20 posts and `scanned` says how many were read, so a short page means few media posts in that stretch, not the end. Costs 3 credits per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: monzo
          description: X username without the @.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/x/user-search:
    get:
      operationId: x_user_search
      tags:
        - X
      summary: Search accounts
      description: "Keyword search over X accounts: profile cards with handle, name, bio, location, follower/following/post counts, join date and avatar, with cursor pagination. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: fintech founder
          description: Keywords matched against account names, handles and bios.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Opaque cursor from the previous page's cursor field.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/yelp/business:
    get:
      operationId: yelp_business
      tags:
        - Yelp
      summary: Yelp business
      description: One Yelp business record. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: the-old-fashioned-madison
          description: Business id or alias, or its yelp.com URL
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/yelp/menu:
    get:
      operationId: yelp_menu
      tags:
        - Yelp
      summary: Yelp business menu
      description: The menu of a Yelp business in sections with prices, when one is published. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: RJNAeNA-209sctUO0dmwuA
          description: Business id or alias
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/yelp/photos:
    get:
      operationId: yelp_photos
      tags:
        - Yelp
      summary: Yelp business photos
      description: Photos and videos of a Yelp business, twenty per page, with the category counts. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: RJNAeNA-209sctUO0dmwuA
          description: Business id or alias
        - name: category
          in: query
          required: false
          schema:
            type: string
          example: food
          description: Media category slug (food, drink, menu, ...)
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (20 per page)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/yelp/related:
    get:
      operationId: yelp_related
      tags:
        - Yelp
      summary: Yelp related businesses
      description: Businesses the platform recommends alongside one business. Costs 1 credit per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: RJNAeNA-209sctUO0dmwuA
          description: Business id or alias
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Up to 20
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/yelp/reviews:
    get:
      operationId: yelp_reviews
      tags:
        - Yelp
      summary: Yelp business reviews
      description: Reviews of a Yelp business, ten per page, with the author profile, votes, photos and any owner reply. Costs 3 credits per successful live response.
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: RJNAeNA-209sctUO0dmwuA
          description: Business id or alias, or its yelp.com URL
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (10 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: yelp (default) or newest
        - name: keywords
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only reviews mentioning this text
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: ISO 639-1 language
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/yelp/search:
    get:
      operationId: yelp_search
      tags:
        - Yelp
      summary: Yelp business search
      description: Businesses matching a query near a place, twenty per page, with rating, review count, price range, contact details and coordinates. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Cheese Curds
          description: What to look for
        - name: location
          in: query
          required: true
          schema:
            type: string
          example: Madison, WI
          description: City, address or postcode
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (20 per page)
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: recommended
          description: Result ordering
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/yelp/search-suggestions:
    get:
      operationId: yelp_search_suggestions
      tags:
        - Yelp
      summary: Yelp search suggestions (businesses)
      description: "PARTIAL: business suggestions for a typed query near a place (name, id, URL, rating, address), from the held listing's search. The platform's own typeahead rows for categories, common terms and chains are not served; the answer lists what is missing. Costs 1 credit per successful live response."
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: pizza
          description: Search words as typed
        - name: location
          in: query
          required: true
          schema:
            type: string
          example: New York, NY
          description: City, address or postcode
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/youtube/channel:
    get:
      operationId: youtube_channel
      tags:
        - YouTube
      summary: YouTube channel
      description: "Channel profile: title, handle, subscriber/view/video counts, avatar, banner and the uploads playlist id. Costs 1 credit per successful live response."
      parameters:
        - name: channelId
          in: query
          required: false
          schema:
            type: string
          example: UC_x5XG1OV2P6uZZ5FSM9Ttw
          description: Channel id (UC…). One of channelId, handle, forUsername or url is required
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: "@googledevelopers"
          description: Channel @handle (with or without the @)
        - name: forUsername
          in: query
          required: false
          schema:
            type: string
          example: GoogleDevelopers
          description: Legacy channel username
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.youtube.com/@googledevelopers
          description: Any channel URL (/channel/UC…, /@handle, /user/…, /c/…)
        - name: hl
          in: query
          required: false
          schema:
            type: string
          example: en
          description: BCP-47 language for localized snippet text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/channel/playlists:
    get:
      operationId: youtube_channel_playlists
      tags:
        - YouTube
      summary: YouTube channel playlists
      description: "Public playlists owned by a channel: title, description, item count and privacy. Costs 1 credit per successful live response."
      parameters:
        - name: channelId
          in: query
          required: false
          schema:
            type: string
          example: UC_x5XG1OV2P6uZZ5FSM9Ttw
          description: Channel id. One of channelId, handle or url is required
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: "@googledevelopers"
          description: Channel @handle (resolved to a channel id first)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.youtube.com/@googledevelopers
          description: Any channel URL
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: CAUQAA
          description: Opaque page token from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/channel/videos:
    get:
      operationId: youtube_channel_videos
      tags:
        - YouTube
      summary: YouTube channel videos
      description: A channel's uploaded videos, newest first, read from its uploads playlist. Costs 1 credit per successful live response.
      parameters:
        - name: channelId
          in: query
          required: false
          schema:
            type: string
          example: UC_x5XG1OV2P6uZZ5FSM9Ttw
          description: Channel id. One of channelId, handle or url is required
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: "@googledevelopers"
          description: Channel @handle
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.youtube.com/@googledevelopers
          description: Any channel URL
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: CAUQAA
          description: Opaque page token from a previous response
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: Accepted for compatibility but ignored — uploads come newest-first (noted in _warnings)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/channels:
    get:
      operationId: youtube_channels
      tags:
        - YouTube
      summary: YouTube channels (batch)
      description: Batch channel lookup — one normalized record per id; unknown/terminated ids are reported in `missing`. Costs 2 credits per successful live response.
      parameters:
        - name: ids
          in: query
          required: true
          schema:
            type: string
          example: UC_x5XG1OV2P6uZZ5FSM9Ttw,UCrDkAvwZum-UTjHmzDI2iIw
          description: Comma-separated (or JSON array of) channel ids; up to 250, chunked 50 per upstream call
        - name: hl
          in: query
          required: false
          schema:
            type: string
          example: en
          description: BCP-47 language for localized snippet text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/community-post:
    get:
      operationId: youtube_community_post
      tags:
        - YouTube
      summary: Community post
      description: One community post by URL. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/post/UgkxzJ6r7VLAK03TN5Gjq7YpjHmjtee_Rdn9
          description: Full community post URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/community-posts:
    get:
      operationId: youtube_community_posts
      tags:
        - YouTube
      summary: Community posts
      description: "A channel's community-tab posts: text, images, likes and attached videos. Paged by cursor. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: MrBeast
          description: Channel handle without the @ (or pass channelId).
        - name: channelId
          in: query
          required: false
          schema:
            type: string
          description: Channel id — alternative to handle.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: continuationToken from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/lives:
    get:
      operationId: youtube_lives
      tags:
        - YouTube
      summary: Channel live streams
      description: "A channel's live tab: current and past streams with view counts and live state. Paged by cursor. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: IShowSpeed
          description: Channel handle without the @ (or pass channelId).
        - name: channelId
          in: query
          required: false
          schema:
            type: string
          description: Channel id — alternative to handle.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: continuationToken from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/playlist:
    get:
      operationId: youtube_playlist
      tags:
        - YouTube
      summary: YouTube playlist
      description: "Playlist metadata: title, description, owning channel, video count and privacy. Costs 1 credit per successful live response."
      parameters:
        - name: playlist_id
          in: query
          required: true
          schema:
            type: string
          example: PLOU2XLYxmsIKpaV8h0AGE05so0fAwwfTw
          description: Playlist id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/playlist/items:
    get:
      operationId: youtube_playlist_items
      tags:
        - YouTube
      summary: YouTube playlist items
      description: The videos in a playlist, in playlist order, with per-item position and dates. Costs 1 credit per successful live response.
      parameters:
        - name: playlist_id
          in: query
          required: true
          schema:
            type: string
          example: PLOU2XLYxmsIKpaV8h0AGE05so0fAwwfTw
          description: Playlist id
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: CAUQAA
          description: Opaque page token from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/post-transcript:
    get:
      operationId: youtube_post_transcript
      tags:
        - YouTube
      summary: Video transcript
      description: The spoken words of a YouTube video as timestamped segments plus plain text. transcript is null when the video has no captions. Costs 5 credits per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/watch?v=jNQXAC9IVRw
          description: Full YouTube video URL.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/profile:
    get:
      operationId: youtube_profile
      tags:
        - YouTube
      summary: YouTube channel profile
      description: "Public YouTube channel: identity, description, subscriber/video/view counts. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: "@NASA"
          description: Channel handle, e.g. @NASA.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/profile/full:
    get:
      operationId: youtube_profile_full
      tags:
        - YouTube
      summary: YouTube profile (full)
      description: "One-call channel dossier: channel profile, recent uploads with stats, and computed engagement analytics; per-source failures reported inline. Costs 5 credits per successful live response."
      parameters:
        - name: channelId
          in: query
          required: false
          schema:
            type: string
          example: UC_x5XG1OV2P6uZZ5FSM9Ttw
          description: Channel id. One of channelId, handle or url is required
        - name: handle
          in: query
          required: false
          schema:
            type: string
          example: "@googledevelopers"
          description: Channel @handle
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: https://www.youtube.com/@googledevelopers
          description: Any channel URL
        - name: posts
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: Recent uploads to sample for analytics, 1-50 (default 10)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: CAUQAA
          description: Opaque page token to continue the recent-uploads listing
        - name: include
          in: query
          required: false
          schema:
            type: string
          example: videos,analytics
          description: "Comma list: videos and/or analytics (default both)"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 5
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/search:
    get:
      operationId: youtube_search
      tags:
        - YouTube
      summary: YouTube search
      description: Search YouTube for videos, channels and playlists (Data API search.list; 100 quota units per call). Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: lofi hip hop
          description: Search query
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: video
          description: "Result kinds: video, channel, playlist (comma-separable)"
        - name: sortBy
          in: query
          required: false
          schema:
            type: string
          example: date
          description: relevance, date, rating, title or views (maps to order/viewCount)
        - name: duration
          in: query
          required: false
          schema:
            type: string
          example: medium
          description: short, medium or long (forces video results)
        - name: uploadDate
          in: query
          required: false
          schema:
            type: string
          example: week
          description: hour/today/week/month/year — mapped to publishedAfter
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: ISO-3166 region code (maps to regionCode)
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Results per page, max 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: CAUQAA
          description: Opaque page token from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/search/advanced:
    get:
      operationId: youtube_search_advanced
      tags:
        - YouTube
      summary: YouTube advanced search
      description: Advanced YouTube search exposing the Data API search.list filters (order, duration, event/type, category, geo, dates, captions and more). Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: machine learning
          description: Search query
        - name: order
          in: query
          required: false
          schema:
            type: string
          example: viewCount
          description: relevance, date, rating, title or viewCount
        - name: duration
          in: query
          required: false
          schema:
            type: string
          example: long
          description: short, medium or long (forces video results)
        - name: event_type
          in: query
          required: false
          schema:
            type: string
          example: completed
          description: live, upcoming or completed (forces video results)
        - name: license
          in: query
          required: false
          schema:
            type: string
          example: creativeCommon
          description: any, creativeCommon or youtube (maps to videoLicense)
        - name: category
          in: query
          required: false
          schema:
            type: string
          example: "28"
          description: videoCategoryId
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: ISO-3166 region code (maps to regionCode)
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Preferred content language (maps to relevanceLanguage)
        - name: published_after
          in: query
          required: false
          schema:
            type: string
          example: "2024-01-01T00:00:00Z"
          description: RFC-3339 lower bound (maps to publishedAfter)
        - name: published_before
          in: query
          required: false
          schema:
            type: string
          example: "2025-01-01T00:00:00Z"
          description: RFC-3339 upper bound (maps to publishedBefore)
        - name: channel_id
          in: query
          required: false
          schema:
            type: string
          example: UC_x5XG1OV2P6uZZ5FSM9Ttw
          description: Restrict to a channel (maps to channelId)
        - name: safe_search
          in: query
          required: false
          schema:
            type: string
          example: moderate
          description: none, moderate or strict (maps to safeSearch)
        - name: video_caption
          in: query
          required: false
          schema:
            type: string
          example: closedCaption
          description: any, closedCaption or none (maps to videoCaption)
        - name: video_definition
          in: query
          required: false
          schema:
            type: string
          example: high
          description: any, standard or high (maps to videoDefinition)
        - name: video_dimension
          in: query
          required: false
          schema:
            type: string
          example: 2d
          description: 2d, 3d or any (maps to videoDimension)
        - name: video_embeddable
          in: query
          required: false
          schema:
            type: string
          example: "true"
          description: true or any (maps to videoEmbeddable)
        - name: video_type
          in: query
          required: false
          schema:
            type: string
          example: movie
          description: any, episode or movie (maps to videoType)
        - name: topic_id
          in: query
          required: false
          schema:
            type: string
          example: /m/019_rr
          description: Freebase topic id (maps to topicId)
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: 37.42307,-122.08427
          description: lat,long point (maps to location; requires location_radius)
        - name: location_radius
          in: query
          required: false
          schema:
            type: string
          example: 10km
          description: Search radius, e.g. 10km (maps to locationRadius)
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Results per page, max 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: CAUQAA
          description: Opaque page token from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/search/hashtag:
    get:
      operationId: youtube_search_hashtag
      tags:
        - YouTube
      summary: YouTube hashtag search
      description: Best-effort hashtag search — a search.list keyword query for the "#tag" token (Data API has no dedicated hashtag endpoint; noted in _warnings). Costs 1 credit per successful live response.
      parameters:
        - name: hashtag
          in: query
          required: true
          schema:
            type: string
          example: shorts
          description: "Hashtag with or without the leading #"
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: video
          description: Result kind (defaults to video)
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Results per page, max 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: CAUQAA
          description: Opaque page token from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/shorts:
    get:
      operationId: youtube_shorts
      tags:
        - YouTube
      summary: Channel Shorts
      description: "A channel's Shorts shelf: title, URL, views, likes and comments per short. Paged by cursor. Costs 1 credit per successful live response."
      parameters:
        - name: handle
          in: query
          required: true
          schema:
            type: string
          example: starterstory
          description: Channel handle without the @ (or pass channelId).
        - name: channelId
          in: query
          required: false
          schema:
            type: string
          description: Channel id — alternative to handle.
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: newest or popular.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: continuationToken from the previous page.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/shorts-trending:
    get:
      operationId: youtube_shorts_trending
      tags:
        - YouTube
      summary: Trending Shorts
      description: The current trending Shorts feed with engagement counts. Costs 3 credits per successful live response.
      parameters: []
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/typeahead:
    get:
      operationId: youtube_typeahead
      tags:
        - YouTube
      summary: Search suggestions
      description: YouTube's own search suggestions for a query — channels are identified with id and handle. Keyword-research signal. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: mr beast
          description: Partial query.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/video:
    get:
      operationId: youtube_video
      tags:
        - YouTube
      summary: YouTube video
      description: "Full video details: title, description, duration, view/like/comment counts, thumbnails and live details. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/watch?v=9bZkp7q19f0
          description: Video URL (watch, youtu.be, /shorts/…) or a bare 11-char video id
        - name: hl
          in: query
          required: false
          schema:
            type: string
          example: en
          description: BCP-47 language for localized snippet text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/video-sponsors:
    get:
      operationId: youtube_video_sponsors
      tags:
        - YouTube
      summary: Sponsor detection
      description: "Detects the paid-promotion flag and infers likely sponsors from the description, links, promo codes and transcript — every sponsor carries its evidence. Experimental: absence of a detection is not proof there is no sponsor. Costs 4 credits per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/watch?v=AVO0ifle-OU
          description: Full YouTube video URL.
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Transcript language.
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 4
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/video/audio:
    get:
      operationId: youtube_video_audio
      tags:
        - YouTube
      summary: YouTube video audio streams
      description: "The audio-only streams the platform offers for a video: format tag, direct time-limited link, MIME type, bitrate, sample rate, channels and duration. Links expire; fetch them promptly. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/watch?v=dQw4w9WgXcQ
          description: Video URL or id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/youtube/video/comment/replies:
    get:
      operationId: youtube_video_comment_replies
      tags:
        - YouTube
      summary: YouTube comment replies
      description: Replies under a specific top-level comment, addressed by the parent comment id. Costs 1 credit per successful live response.
      parameters:
        - name: comment_id
          in: query
          required: true
          schema:
            type: string
          example: Ugz1234567890AbCdEf4AaABAg
          description: Top-level (parent) comment id whose replies to fetch. the reference catalogue continuationToken is accepted as this id
        - name: format
          in: query
          required: false
          schema:
            type: string
          example: plainText
          description: html or plainText comment text (maps to textFormat)
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Replies per page, max 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: QURTSl9pMg
          description: Opaque page token from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/video/comments:
    get:
      operationId: youtube_video_comments
      tags:
        - YouTube
      summary: YouTube video comments
      description: Top-level comment threads on a video; comments-disabled videos surface as 404. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/watch?v=9bZkp7q19f0
          description: Video URL or a bare 11-char video id
        - name: order
          in: query
          required: false
          schema:
            type: string
          example: relevance
          description: time or relevance (Data API order)
        - name: searchTerm
          in: query
          required: false
          schema:
            type: string
          example: great video
          description: Only comments matching this term (maps to searchTerms)
        - name: format
          in: query
          required: false
          schema:
            type: string
          example: plainText
          description: html or plainText comment text (maps to textFormat)
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Top-level comment threads per page, max 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: QURTSl9pMg
          description: Opaque page token from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/video/files:
    get:
      operationId: youtube_video_files
      tags:
        - YouTube
      summary: YouTube video stream files
      description: "The video stream files the platform offers for a video: format tag, direct time-limited link, MIME type, quality label, size, frame rate, bitrate and duration. Links expire; fetch them promptly. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/watch?v=dQw4w9WgXcQ
          description: Video URL or id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/youtube/video/subtitles:
    get:
      operationId: youtube_video_subtitles
      tags:
        - YouTube
      summary: YouTube caption tracks
      description: "The caption tracks a video carries: language code and name, whether auto-generated, and the track link. The transcript text itself is youtube/post-transcript. Costs 1 credit per successful live response."
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/watch?v=dQw4w9WgXcQ
          description: Video URL or id
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Restrict to one language code
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: false
  /v1/youtube/video/thumbnails:
    get:
      operationId: youtube_video_thumbnails
      tags:
        - YouTube
      summary: YouTube video thumbnails
      description: A video's thumbnail set from the snippet, plus conventional i.ytimg.com URLs for every size. Costs 1 credit per successful live response.
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: https://www.youtube.com/watch?v=9bZkp7q19f0
          description: Video URL or a bare 11-char video id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/videos:
    get:
      operationId: youtube_videos
      tags:
        - YouTube
      summary: YouTube videos (batch)
      description: Batch video lookup — one normalized record per id; unknown/private/deleted ids are reported in `missing`. Costs 2 credits per successful live response.
      parameters:
        - name: ids
          in: query
          required: true
          schema:
            type: string
          example: 9bZkp7q19f0,kJQP7kiw5Fk
          description: Comma-separated (or JSON array of) video ids or URLs; up to 250, chunked 50 per upstream call
        - name: hl
          in: query
          required: false
          schema:
            type: string
          example: en
          description: BCP-47 language for localized snippet text
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/youtube/videos/trending:
    get:
      operationId: youtube_videos_trending
      tags:
        - YouTube
      summary: YouTube trending videos
      description: The most-popular videos chart (videos.list chart=mostPopular) for a region and optional category. Costs 1 credit per successful live response.
      parameters:
        - name: region
          in: query
          required: false
          schema:
            type: string
          example: US
          description: ISO-3166 region code (default US; maps to regionCode)
        - name: category
          in: query
          required: false
          schema:
            type: string
          example: "10"
          description: videoCategoryId to restrict the chart
        - name: language
          in: query
          required: false
          schema:
            type: string
          example: en
          description: Localized text language (maps to hl)
        - name: max_results
          in: query
          required: false
          schema:
            type: string
          example: "25"
          description: Items per page, max 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          example: CAUQAA
          description: Opaque page token from a previous response
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/agent:
    get:
      operationId: zoopla_agent
      tags:
        - Zoopla
      summary: Zoopla agent
      description: "One agent branch's page: address, telephone, website and social links, memberships, description, photos and position. Costs 2 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "55447"
          description: The branch id from zoopla/agents (or pass url, the branch's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The branch's page URL instead of an id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/agents:
    get:
      operationId: zoopla_agents
      tags:
        - Zoopla
      summary: Zoopla agents
      description: "The agent branches in an area with each one's market figures: homes available, average asking price and weeks on the market, for sale and to rent. Costs 2 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Oxford
          description: A postcode, town or area name; resolved once and remembered (or pass identifier)
        - name: identifier
          in: query
          required: false
          schema:
            type: string
          example: oxford
          description: An area identifier from zoopla/locations or a path from zoopla/area
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (25 a page)
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: "Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40"
        - name: type
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: sales, lettings or commercial
        - name: name
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only agents whose name contains this
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: a_z
          description: a_z, shortest_avg_age, highest_avg_price or lowest_avg_price
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/area:
    get:
      operationId: zoopla_area
      tags:
        - Zoopla
      summary: Zoopla postcode area
      description: "The house-prices area for a postcode: its path (for zoopla/estimates and zoopla/agents), name and kind. Costs 1 credit per successful live response."
      parameters:
        - name: postcode
          in: query
          required: true
          schema:
            type: string
          example: SW2 1AH
          description: A full postcode, or an area name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/estimates:
    get:
      operationId: zoopla_estimates
      tags:
        - Zoopla
      summary: Zoopla street estimates
      description: Every address along one street with the portal's sale estimate, its attributes and its recorded sales, plus the street's market line (average price paid, properties sold). Costs 3 credits per successful live response.
      parameters:
        - name: path
          in: query
          required: true
          schema:
            type: string
          example: london/oxford-road-se19
          description: A street path from zoopla/streets or zoopla/area
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: string
          example: "12"
          description: Addresses per page, 1 to 50
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/locations:
    get:
      operationId: zoopla_locations
      tags:
        - Zoopla
      summary: Zoopla area lookup
      description: The areas the portal knows for a name, each with the identifier and label the searches take. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Oxford
          description: A postcode, town or area name
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/property:
    get:
      operationId: zoopla_property
      tags:
        - Zoopla
      summary: Zoopla property
      description: "One listing's page: title, address and UPRN, rooms and floor area, price with its qualifier and price per square foot, tenure, the portal's key facts (service charge, council tax, water…), EPC rating, description and features, photos, floorplans, transport and schools nearby, price history and the agent branch. Costs 3 credits per successful live response."
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: "69200045"
          description: The listing number (or pass url, the listing's page)
        - name: url
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The listing's page URL instead of an id
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/property-history:
    get:
      operationId: zoopla_property_history
      tags:
        - Zoopla
      summary: Zoopla property history
      description: The recorded sales of one address (date, price, change since the sale before) and the listings the portal has seen for it. Costs 2 credits per successful live response.
      parameters:
        - name: uprn
          in: query
          required: true
          schema:
            type: string
          example: "10013983744"
          description: The property's UPRN, from zoopla/property or zoopla/estimates
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 2
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/search-rent:
    get:
      operationId: zoopla_search_rent
      tags:
        - Zoopla
      summary: Zoopla homes to rent
      description: "Homes to rent in an area: address, title, rooms, monthly rent and its label, available-from date, agent, photos and position; the portal's featured homes beside them. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Oxford
          description: A postcode, town or area name; resolved to the portal's identifier once and remembered (or pass identifier and label)
        - name: identifier
          in: query
          required: false
          schema:
            type: string
          example: oxford
          description: An area identifier from zoopla/locations
        - name: label
          in: query
          required: false
          schema:
            type: string
          example: Oxford, Oxfordshire
          description: The area's label from zoopla/locations, sent with the identifier
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: "Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40"
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum monthly rent in pounds
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum monthly rent in pounds
        - name: min_bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum bedrooms
        - name: max_bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum bedrooms
        - name: min_bathrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum bathrooms
        - name: max_bathrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum bathrooms
        - name: property_type
          in: query
          required: false
          schema:
            type: string
          example: flats
          description: detached, semi_detached, terraced, flats, bungalow; several separated by commas
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: newest, highest_price, lowest_price or most_reduced
        - name: keywords
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Words the listing must mention
        - name: must_have
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: has_garden, has_parking_garage, has_balcony_terrace and the portal's other must-haves; separated by commas
        - name: features
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The portal's property-feature codes, separated by commas
        - name: added
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only homes added in the last 1, 3, 7, 14 or 30 days
        - name: include_rented
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Include homes already let or let agreed
        - name: furnished
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: any, furnished, part_furnished or unfurnished
        - name: available_from
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: now, 1months, 3months, 6months or 12months
        - name: retirement_homes
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: include, exclude or only
        - name: house_share
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: include, exclude or only
        - name: student
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: "Student accommodation: include, exclude or only"
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/search-sale:
    get:
      operationId: zoopla_search_sale
      tags:
        - Zoopla
      summary: Zoopla homes for sale
      description: "Homes for sale in an area: address, title, rooms, price and its label, flag, agent, photos and position; the portal's featured homes beside them. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: false
          schema:
            type: string
          example: Oxford
          description: A postcode, town or area name; resolved to the portal's identifier once and remembered (or pass identifier and label)
        - name: identifier
          in: query
          required: false
          schema:
            type: string
          example: oxford
          description: An area identifier from zoopla/locations
        - name: label
          in: query
          required: false
          schema:
            type: string
          example: Oxford, Oxfordshire
          description: The area's label from zoopla/locations, sent with the identifier
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number
        - name: radius
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: "Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40"
        - name: min_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum asking price in pounds
        - name: max_price
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum asking price in pounds
        - name: min_bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum bedrooms
        - name: max_bedrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum bedrooms
        - name: min_bathrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Minimum bathrooms
        - name: max_bathrooms
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Maximum bathrooms
        - name: property_type
          in: query
          required: false
          schema:
            type: string
          example: flats,terraced
          description: detached, semi_detached, terraced, flats, bungalow, farms_land, park_home; several separated by commas
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: newest
          description: newest, highest_price, lowest_price or most_reduced
        - name: keywords
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Words the listing must mention
        - name: must_have
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: has_garden, has_parking_garage, has_balcony_terrace and the portal's other must-haves; separated by commas
        - name: features
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: The portal's property-feature codes, separated by commas
        - name: added
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: Only homes added in the last 1, 3, 7, 14 or 30 days
        - name: include_sold
          in: query
          required: false
          schema:
            type: string
          example: "false"
          description: Include homes under offer or sold subject to contract
        - name: new_homes
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: include, exclude or only
        - name: retirement_homes
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: include, exclude or only
        - name: auction
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: include, exclude or only
        - name: shared_ownership
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: include, exclude or only
        - name: show_only
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: chainFree, reducedPriceOnly; separated by commas
        - name: ownership
          in: query
          required: false
          schema:
            type: string
          example: ""
          description: leasehold, freehold, share_of_freehold; separated by commas
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/sold-prices:
    get:
      operationId: zoopla_sold_prices
      tags:
        - Zoopla
      summary: Zoopla sold prices
      description: "The Land Registry sales in an area as the portal indexes them: each address with its last sale, its attributes and its UPRN, and the area's average prices by property type. Costs 3 credits per successful live response."
      parameters:
        - name: location
          in: query
          required: true
          schema:
            type: string
          example: Oxford
          description: A town, area, postcode or outcode, or a path such as london/croydon
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: "1"
          description: Page number (25 a page)
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/streets:
    get:
      operationId: zoopla_streets
      tags:
        - Zoopla
      summary: Zoopla street lookup
      description: The streets and addresses the house-prices index knows for a name, each with the path zoopla/estimates takes. Costs 1 credit per successful live response.
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          example: Oxford Road
          description: Part of a street name or address
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 1
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/zoopla/valuation:
    get:
      operationId: zoopla_valuation
      tags:
        - Zoopla
      summary: Zoopla valuation
      description: "The portal's valuation of one address, by UPRN or by street address: the current sale and rent estimates with their range and confidence, the estimate's history, the Land Registry sales, live and similar listings nearby, and the schools and stations around it. Costs 3 credits per successful live response."
      parameters:
        - name: uprn
          in: query
          required: false
          schema:
            type: string
          example: "200001198316"
          description: The property's UPRN, from zoopla/property, zoopla/estimates, zoopla/streets or zoopla/sold-prices (or pass address)
        - name: address
          in: query
          required: false
          schema:
            type: string
          example: 45 Princes Avenue, South Croydon CR2 9BE
          description: A street address with its postcode instead of a UPRN
      security:
        - ApiKeyHeader: []
        - BearerKey: []
      responses:
        "200":
          description: "The common success envelope; `data` is endpoint-specific. Many lists use items/count/cursor; bundles use named collections and their documented continuation metadata. HTTP 200 can contain a partial bundle: inspect complete, partial and legs where supplied."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Success"
        default:
          description: The error envelope — the same shape for every non-2xx status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      x-credits: 3
      x-production-available: true
      x-availability-scope: Structural check of the effective registered chain, production permission, adapter, configured cost and quality floor without request parameters. True is not a live-health, credential, quota, subscription-entitlement, complete-data or deployment-exposure guarantee. False means no structurally eligible candidate; null means metadata could not establish availability. Composite child capability still depends on its component routes.
      x-live-proven: true
  /v1/batch:
    post:
      operationId: batch
      tags:
        - Batch
      summary: Run up to 20 requests in one call
      description: Each item runs through the full pipeline independently — items may target different platforms, and one item failing does not affect its siblings. The wrapper itself costs nothing; you pay only for the calls inside it. Auth is header-only (`x-api-key`).
      security:
        - ApiKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BatchRequest"
      responses:
        "200":
          description: Per-item results in request order. Check each item's own `status` and `success`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BatchResponse"
        default:
          description: The error envelope (the batch itself was rejected — bad body, auth, or rate limit).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Your API key (`mn_…`), from the console. The recommended style.
    BearerKey:
      type: http
      scheme: bearer
      description: The same key as a Bearer token, for clients that only expose an Authorization field. Keys are never accepted in the query string — URLs leak into logs and referrers.
  schemas:
    Success:
      type: object
      required:
        - success
        - platform
        - endpoint
        - data
        - credits_used
        - credits_remaining
        - request_id
      properties:
        success:
          const: true
        platform:
          type: string
        endpoint:
          type: string
          description: The resolved path, e.g. `/v1/github/profile`.
        data:
          description: Endpoint-specific normalized payload, not one universal post/profile schema. Many lists use items/count/cursor; a null cursor means no usable next cursor was supplied, not proof that all history was retrieved. Check has_more and warnings where present. Social full-profile bundles use posts_cursor and posts_pagination.next_params; retain all returned next parameters. YouTube channel bundles instead use recent_videos, cursor and recent_videos_pagination. Inspect complete/partial/legs where supplied for bounded or failed components. Optional model-derived fields are labelled, not source facts.
        credits_used:
          type: integer
        credits_remaining:
          type: integer
        request_id:
          type: string
        cached:
          type: boolean
        synthetic:
          type: boolean
          description: Present and true only on the explicitly requested /sandbox surface. Synthetic responses are representative and charged 0 credits; production /v1 never returns them.
        degraded:
          type: boolean
          description: Reserved for sandbox compatibility. Production /v1 reports upstream failure as an error and never serves a representative fallback.
    Error:
      type: object
      required:
        - success
        - error
        - credits_used
        - request_id
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - type
            - message
            - status
          properties:
            type:
              type: string
              enum:
                - UNAUTHORIZED
                - KEY_REVOKED
                - KEY_LIMIT_EXCEEDED
                - RATE_LIMITED
                - INSUFFICIENT_CREDITS
                - RESOURCE_NOT_FOUND
                - INVALID_PARAMETERS
                - UPSTREAM_ERROR
                - UPSTREAM_TIMEOUT
                - ENDPOINT_NOT_FOUND
                - ENDPOINT_NOT_AVAILABLE
                - FAIR_USE_EXCEEDED
                - INTERNAL_ERROR
            message:
              type: string
            status:
              type: integer
            doc_url:
              type: string
              description: Deep link to the exact section of the errors guide for this type.
            details:
              type: object
        credits_used:
          type: integer
        credits_remaining:
          type: integer
        request_id:
          type: string
    BatchRequest:
      type: object
      required:
        - requests
      properties:
        requests:
          type: array
          maxItems: 20
          items:
            type: object
            required:
              - platform
              - endpoint
            properties:
              platform:
                type: string
                example: github
              endpoint:
                type: string
                example: profile
              params:
                type: object
                additionalProperties:
                  type: string
    BatchResponse:
      type: object
      properties:
        success:
          const: true
        count:
          type: integer
        succeeded:
          type: integer
        failed:
          type: integer
        credits_used:
          type: integer
          description: Sum across items.
        credits_remaining:
          type: integer
          description: The lowest balance any item observed while the batch ran.
        results:
          type: array
          items:
            allOf:
              - type: object
                properties:
                  index:
                    type: integer
                  status:
                    type: integer
              - oneOf:
                  - $ref: "#/components/schemas/Success"
                  - $ref: "#/components/schemas/Error"