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

# Options open interest

> Returns a coin's options open interest on Deribit, OKX, Bybit and Binance, read every hour: each venue's latest reading summed, by expiry (with put/call ratio and max pain) and by strike, each venue's hourly totals, and the ratio of options to futures open interest. Open interest is one side in US dollars; Deribit publishes it 8 hours late, so its reading is 8 hours older than the others'. History starts on 2026-11-17, when capture began.



## OpenAPI

````yaml /openapi.json get /v1/options/open-interest
openapi: 3.0.0
info:
  title: Sharpe API
  version: 1.0.0
  description: >-
    Institutional-grade crypto market data API. Access funding rates, futures,
    arbitrage opportunities, narratives, ecosystems, and more.


    Authentication is supported via two production-safe methods:

    1. **Bearer token** in the Authorization header: `Authorization: Bearer
    sk_live_...`

    2. **X-API-Key header**: `X-API-Key: sk_live_...`


    API keys in query parameters are rejected by default because URLs are
    commonly stored in logs, browser history, analytics tools, and referrer
    headers.


    These `/v1` endpoints send no CORS headers and must be called from a server:
    calling them from a browser would expose your API key in page JavaScript.


    Every endpoint needs an API key, except `/v1/health` and
    `/v1/meta/coverage`. A key works on a paid plan
    (https://www.sharpe.ai/pricing) or during its account's one-time trial of 7
    days and 250 requests; otherwise it answers 401 `expired_api_key`. There is
    no free API tier and no keyless API.
  contact:
    name: Sharpe API Support
    url: https://sharpe.ai
    email: team@sharpe.ai
servers:
  - url: https://www.sharpe.ai/api
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: System
    description: Health checks and service status
  - name: Account
    description: API key usage and quota information
  - name: Derivatives
    description: Funding rates and futures data
  - name: Market Data
    description: >-
      Heatmaps, correlations, tracker, price predictions, news, gem finder, and
      market cap search
  - name: Arbitrage
    description: >-
      Spot-perp, cross-exchange, dated futures basis, calendar spread,
      perp-dated carry, and transfer arbitrage scanners
  - name: Categories
    description: Narratives, ecosystems, and memecoins data
  - name: New Listings
    description: >-
      Spot listings, Perp listings, delistings, suspensions, scheduled trading
      starts, exchange pages, and narrative flow across CEXs and Perp DEXs.
  - name: Screener
    description: Rug Check security, holders, resolve and trending endpoints.
  - name: Signals
    description: >-
      Composite signal scores derived from cross-exchange derivatives data:
      insider selling pressure and pump-and-dump detection.
  - name: Reports
    description: >-
      Markdown reports rendered on the server from the endpoints above: the
      market briefing, one coin's analysis, and the funding-arbitrage
      opportunities.
paths:
  /v1/options/open-interest:
    get:
      tags:
        - Derivatives
      summary: Options open interest
      description: >-
        Returns a coin's options open interest on Deribit, OKX, Bybit and
        Binance, read every hour: each venue's latest reading summed, by expiry
        (with put/call ratio and max pain) and by strike, each venue's hourly
        totals, and the ratio of options to futures open interest. Open interest
        is one side in US dollars; Deribit publishes it 8 hours late, so its
        reading is 8 hours older than the others'. History starts on 2026-11-17,
        when capture began.
      operationId: getOptionsOpenInterest
      parameters:
        - name: coin
          in: query
          description: Base coin ticker (BTC, ETH, SOL, XRP, ...).
          schema:
            type: string
            minLength: 1
            maxLength: 20
            default: BTC
        - name: exchange
          in: query
          description: One venue; every venue when omitted.
          schema:
            type: string
            enum:
              - Deribit
              - OKX
              - Bybit
              - Binance
        - name: expiry
          in: query
          description: >-
            UTC date (YYYY-MM-DD) whose options `strikes` lists; every expiry
            when omitted.
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: days
          in: query
          description: Days of hourly `history` and `futures_ratio`.
          schema:
            default: 7
            type: integer
            minimum: 1
            maximum: 90
      responses:
        '200':
          description: Options open interest returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionsOpenInterestResponse'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Quota-Limit:
              $ref: '#/components/headers/X-Quota-Limit'
            X-Quota-Remaining:
              $ref: '#/components/headers/X-Quota-Remaining'
            X-Quota-Reset:
              $ref: '#/components/headers/X-Quota-Reset'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    OptionsOpenInterestResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/OptionsOpenInterest'
          required:
            - data
    SuccessEnvelope:
      type: object
      properties:
        data:
          description: >-
            Endpoint-specific response payload. See the operation response
            schema.
        meta:
          $ref: '#/components/schemas/ApiMeta'
      required:
        - data
        - meta
    OptionsOpenInterest:
      type: object
      properties:
        coin:
          type: string
          description: The coin the options are on.
        total:
          nullable: true
          description: >-
            Every venue in scope at its latest reading, summed; null when no
            venue lists options on the coin with a reading in the last 48 hours.
          type: object
          properties:
            oi:
              type: number
              x-field: options.oi
              description: >-
                Σ of the US-dollar open interest, one side, of a coin's listed
                options in the slice the row names (all, one expiry, one hour),
                each venue in the answer at its latest reading (an hour's own
                readings on a series).
            call_oi:
              type: number
              x-field: options.call_oi
              description: options.oi of the slice's calls only.
            put_oi:
              type: number
              x-field: options.put_oi
              description: options.oi of the slice's puts only.
            put_call_ratio:
              nullable: true
              type: number
              x-field: options.put_call_ratio
              description: >-
                Open interest of a coin's listed puts over its listed calls, in
                base coins, one side, from each venue's latest reading (all the
                venues in the answer, or one expiry of them); null when no call
                holds open interest.
          required:
            - oi
            - call_oi
            - put_oi
            - put_call_ratio
        venues:
          type: array
          items:
            type: object
            properties:
              exchange:
                type: string
              as_of:
                type: string
                format: date-time
                x-field: options.as_of
                description: >-
                  The start of the UTC hour a venue's reading is as of: Deribit
                  publishes open interest 8 hours late, so its hour trails the
                  others' by 8.
              oi:
                type: number
                x-field: options.venue_oi
                description: >-
                  Σ of the US-dollar open interest, one side, of one venue's
                  listed options of a coin at one of its readings: dollars at
                  the venue's own valuation (OKX, Binance) or base coins × its
                  index at the reading's time (Deribit, Bybit).
              call_oi:
                type: number
                x-field: options.venue_call_oi
                description: options.venue_oi of the venue's calls only.
              put_oi:
                type: number
                x-field: options.venue_put_oi
                description: options.venue_oi of the venue's puts only.
            required:
              - exchange
              - as_of
              - oi
              - call_oi
              - put_oi
          description: Each venue's latest reading, largest first.
        expiries:
          type: array
          items:
            type: object
            properties:
              expiry:
                type: string
                format: date-time
                x-field: options.expiry
                description: >-
                  When the options of a row expire, as the venues list it: 08:00
                  UTC on crypto options.
              oi:
                type: number
                x-field: options.oi
                description: >-
                  Σ of the US-dollar open interest, one side, of a coin's listed
                  options in the slice the row names (all, one expiry, one
                  hour), each venue in the answer at its latest reading (an
                  hour's own readings on a series).
              call_oi:
                type: number
                x-field: options.call_oi
                description: options.oi of the slice's calls only.
              put_oi:
                type: number
                x-field: options.put_oi
                description: options.oi of the slice's puts only.
              put_call_ratio:
                nullable: true
                type: number
                x-field: options.put_call_ratio
                description: >-
                  Open interest of a coin's listed puts over its listed calls,
                  in base coins, one side, from each venue's latest reading (all
                  the venues in the answer, or one expiry of them); null when no
                  call holds open interest.
              max_pain:
                nullable: true
                type: number
                x-field: options.max_pain
                description: >-
                  The strike of one expiry at which its listed options would pay
                  their holders the least: Σ calls' base coins × max(0, K −
                  strike) + Σ puts' base coins × max(0, strike − K), over the
                  strikes holding open interest, the lowest on a tie, every
                  venue in the answer pooled; null when none holds open
                  interest.
            required:
              - expiry
              - oi
              - call_oi
              - put_oi
              - put_call_ratio
              - max_pain
          description: >-
            Open interest by expiry, soonest first, with each expiry's put/call
            ratio and max pain.
        strikes:
          type: array
          items:
            type: object
            properties:
              strike:
                type: number
                x-field: options.strike
                description: >-
                  An option's strike in quote currency per base coin: USD, USDC
                  or USDT, counted 1:1.
              call_oi:
                type: number
                x-field: options.call_oi
                description: options.oi of the slice's calls only.
              put_oi:
                type: number
                x-field: options.put_oi
                description: options.oi of the slice's puts only.
            required:
              - strike
              - call_oi
              - put_oi
          description: >-
            Open interest by strike, lowest first: over every expiry, or over
            the `expiry` date's options.
        history:
          type: array
          items:
            type: object
            properties:
              timestamp:
                type: string
                format: date-time
                x-field: options.hour
                description: The start of the UTC hour a series point is as of.
              exchange:
                type: string
              oi:
                type: number
                x-field: options.venue_oi
                description: >-
                  Σ of the US-dollar open interest, one side, of one venue's
                  listed options of a coin at one of its readings: dollars at
                  the venue's own valuation (OKX, Binance) or base coins × its
                  index at the reading's time (Deribit, Bybit).
              call_oi:
                type: number
                x-field: options.venue_call_oi
                description: options.venue_oi of the venue's calls only.
              put_oi:
                type: number
                x-field: options.venue_put_oi
                description: options.venue_oi of the venue's puts only.
            required:
              - timestamp
              - exchange
              - oi
              - call_oi
              - put_oi
          description: >-
            Each venue's hourly totals over `days`, oldest first. Deribit's
            hours end 8 hours before the others': it publishes open interest 8
            hours late.
        futures_ratio:
          type: array
          items:
            type: object
            properties:
              timestamp:
                type: string
                format: date-time
                x-field: options.hour
                description: The start of the UTC hour a series point is as of.
              options_oi:
                type: number
                x-field: options.oi
                description: >-
                  Σ of the US-dollar open interest, one side, of a coin's listed
                  options in the slice the row names (all, one expiry, one
                  hour), each venue in the answer at its latest reading (an
                  hour's own readings on a series).
              futures_oi:
                type: number
                x-field: options.futures_oi
                description: >-
                  Σ of the coin's futures open interest in US dollars, one side,
                  over every contract of every venue in the history store that
                  hour, venues kept out of open-interest totals (MEXC and BingX,
                  OI_TOTAL_EXCLUSIONS) left out: what options.futures_ratio
                  divides by.
              ratio:
                type: number
                x-field: options.futures_ratio
                description: >-
                  A coin's options open interest in US dollars (the venues in
                  the answer, at the latest hour every one of them has a
                  reading) over its futures open interest in US dollars that
                  hour (every contract of every venue in the history store,
                  venues kept out of open-interest totals left out); null when
                  either is missing or futures hold none.
            required:
              - timestamp
              - options_oi
              - futures_oi
              - ratio
          description: >-
            Options over futures open interest at each hour of `days` where
            every venue of the snapshot has a reading and the futures hour is
            complete (it starts two hours or more before the current hour, so
            the hourly core sync has copied it after its close), oldest first.
      required:
        - coin
        - total
        - venues
        - expiries
        - strikes
        - history
        - futures_ratio
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: URI identifying the error type.
          example: https://www.sharpe.ai/errors/invalid_parameter
        title:
          type: string
          description: Short human-readable summary.
          example: Invalid Parameter
        status:
          type: integer
          description: HTTP status code.
          example: 400
        detail:
          type: string
          description: Human-readable explanation specific to this occurrence.
          example: 'Invalid parameter "coin": must not be empty'
        request_id:
          type: string
          description: Unique request identifier for support reference.
          example: req_a1b2c3d4e5f6g7h8i9j0
        doc_url:
          type: string
          format: uri
          description: Link to the relevant documentation page for troubleshooting.
          example: https://www.sharpe.ai/docs/errors#error-codes
        suggested_action:
          type: string
          description: Actionable suggestion for resolving the error.
          example: >-
            Check the 'coin' parameter value and ensure it is a valid ticker
            symbol.
      required:
        - type
        - title
        - status
        - detail
        - request_id
        - doc_url
        - suggested_action
      description: Error response following RFC 9457 (Problem Details for HTTP APIs).
    ApiMeta:
      type: object
      properties:
        request_id:
          type: string
          description: Unique request identifier.
          example: req_a1b2c3d4e5f6g7h8i9j0
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp of the response.
        elapsed_ms:
          type: integer
          minimum: 0
          description: Server processing time in milliseconds.
        dataset_id:
          type: string
          enum:
            - funding_rates_current
            - funding_rates_history
            - funding_accumulated
            - funding_fee_settlement
            - global_overview_snapshot
            - futures_open_interest
            - futures_basis
            - futures_term_structure
            - futures_liquidations
            - futures_long_short_ratio
            - futures_ohlcv
            - futures_coins
            - options_open_interest
            - rwa_perp_rates_current
            - arbitrage_tickers
            - arbitrage_boards
            - arbitrage_dated_quotes
            - narratives
            - narrative_bench
            - ecosystems
            - memecoins
            - mindshare
            - sectors
            - chains
            - sector_coins
            - chain_coins
            - gem_finder
            - web_traffic
            - heatmap_cache
            - stablecoins
            - news
            - listings
            - memecoin_launches
            - rug_check_inputs
            - rug_check_trending
            - pump_dump
            - insider_pressure
            - price_prediction_inputs
            - correlation_prices
            - market_cap_search
            - coingecko_coin_list
            - boros_markets
            - margin_borrow_rates
          description: >-
            The dataset the answer is read from; /v1/meta/coverage lists each
            product's datasets with their cadence and SLA.
        as_of:
          nullable: true
          type: string
          format: date-time
          description: >-
            When the data was current: the dataset's own time (the newest live
            row, the snapshot or refresh time, the fetch time), not the response
            time. Null when unknown.
        stale_after:
          nullable: true
          type: string
          format: date-time
          description: >-
            `as_of` plus the freshness SLA: after this instant the data is
            stale, whenever the body is read (a cached copy can be re-judged
            against it).
        freshness_sla_seconds:
          type: number
          description: >-
            Seconds after `as_of` the data stays fresh: the writer's cadence
            plus one skipped run.
        freshness_status:
          type: string
          enum:
            - fresh
            - stale
            - unknown
          description: >-
            `fresh` within the SLA at `generated_at`, `stale` past it, `unknown`
            when `as_of` is null.
        runtime_status:
          type: string
          enum:
            - ok
            - degraded
          description: >-
            `degraded` when this read was incomplete: a leg timed out or failed,
            a row budget was hit, or a fallback answered. Degraded answers are
            never cached.
        served_from:
          type: string
          enum:
            - snapshot
            - table
            - matview
            - live
            - last-good
          description: >-
            Where the rows came from: a precomputed snapshot, a table or
            materialized view, the upstream on request, or the server's last
            good answer.
        generated_at:
          type: string
          format: date-time
          description: >-
            When this answer was built (the instant `freshness_status` is judged
            at).
        source:
          type: array
          items:
            type: string
          description: >-
            The upstream sources behind the rows (source ids such as `binance`,
            `coingecko`).
        coverage:
          type: object
          properties:
            expected:
              type: number
            used:
              type: number
            dropped:
              type: object
              additionalProperties:
                type: number
            missing:
              type: array
              items:
                type: string
          required:
            - expected
            - used
            - dropped
          description: >-
            How complete the stored data is (never whether it is cached): `used`
            of `expected` inputs counted; `dropped` counts the rest by reason (a
            halted market is `not_live`, outside `expected`); `missing` names
            the late ones when known.
        warnings:
          type: array
          items:
            type: string
          description: >-
            What the read could not do, in words (an unreadable table, a late
            writer).
        truncated:
          type: boolean
          description: True when a row budget cut the answer short.
      required:
        - request_id
        - timestamp
        - elapsed_ms
  headers:
    X-Request-Id:
      schema:
        type: string
      description: Unique request identifier. Include this value when contacting support.
    X-RateLimit-Limit:
      schema:
        type: integer
      description: Requests allowed per minute for the authenticated API key.
    X-RateLimit-Remaining:
      schema:
        type: integer
      description: Requests remaining in the current one-minute rate-limit window.
    X-RateLimit-Reset:
      schema:
        type: integer
      description: Unix timestamp in seconds when the current rate-limit window resets.
    X-Quota-Limit:
      schema:
        type: integer
      description: Monthly request quota for the authenticated API key.
    X-Quota-Remaining:
      schema:
        type: integer
      description: Monthly requests remaining in the current billing period.
    X-Quota-Reset:
      schema:
        type: string
        format: date-time
      description: >-
        ISO 8601 timestamp when the monthly quota resets, when available from
        the quota store.
    Retry-After:
      schema:
        type: integer
      description: >-
        Seconds to wait before retrying after a per-minute rate-limit or
        monthly-quota rejection.
  responses:
    BadRequest:
      description: Invalid or missing parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/invalid_parameter
            title: Invalid Parameter
            status: 400
            detail: 'Invalid parameter "coin": must not be empty'
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#error-codes
            suggested_action: >-
              Check the parameter value against the endpoint documentation. Use
              GET /v1/futures/coins or GET /v1/meta/coverage to discover valid
              values.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    Unauthorized:
      description: >-
        Missing or invalid API key, or a key without an active plan
        (`expired_api_key`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid_api_key:
              summary: Missing or invalid API key
              value:
                type: https://www.sharpe.ai/errors/invalid_api_key
                title: Invalid API Key
                status: 401
                detail: >-
                  Missing API key. Pass via Authorization: Bearer <key> or the
                  X-API-Key header.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/authentication
                suggested_action: >-
                  Check your API key is correct. Pass it via Authorization:
                  Bearer <key> or the X-API-Key header.
            expired_api_key:
              summary: The key has no active plan
              value:
                type: https://www.sharpe.ai/errors/expired_api_key
                title: Expired API Key
                status: 401
                detail: >-
                  This API key has no active plan. Subscribe or renew at
                  https://www.sharpe.ai/dashboard/billing.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/authentication
                suggested_action: >-
                  Subscribe or renew at https://www.sharpe.ai/dashboard/billing.
                  The same key works again once the plan is active.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    Forbidden:
      description: The API key lacks a scope this endpoint requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/insufficient_scope
            title: Insufficient Scope
            status: 403
            detail: 'This API key requires the following scope(s): read.'
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/authentication
            suggested_action: >-
              Create a new API key with the required scopes, or contact support
              to update scopes on your existing key.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    RateLimited:
      description: >-
        Per-minute rate limit or monthly quota exceeded. Both are temporary;
        retry after the Retry-After header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rate_limit_exceeded:
              summary: Per-minute rate limit exceeded
              value:
                type: https://www.sharpe.ai/errors/rate_limit_exceeded
                title: Rate Limit Exceeded
                status: 429
                detail: Rate limit of 30 requests per minute exceeded.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/rate-limits
                suggested_action: >-
                  Wait until the time in the X-RateLimit-Reset header before
                  retrying. Upgrade your plan for higher limits.
            monthly_quota_exceeded:
              summary: Monthly quota exceeded
              value:
                type: https://www.sharpe.ai/errors/monthly_quota_exceeded
                title: Monthly Quota Exceeded
                status: 429
                detail: >-
                  Monthly quota of 50,000 requests exceeded. Resets at
                  2026-12-01T00:00:00.000Z.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/rate-limits
                suggested_action: >-
                  Retry after the seconds given in the Retry-After header, when
                  the monthly quota resets. Upgrade your plan for a higher
                  monthly quota. Check usage at GET /v1/usage.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-Quota-Limit:
          $ref: '#/components/headers/X-Quota-Limit'
        X-Quota-Remaining:
          $ref: '#/components/headers/X-Quota-Remaining'
        X-Quota-Reset:
          $ref: '#/components/headers/X-Quota-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/internal_error
            title: Internal Server Error
            status: 500
            detail: An unexpected error occurred. Please try again later.
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#retry-guidance
            suggested_action: >-
              Retry with exponential backoff (1s, 2s, 4s, up to 30s). If the
              error persists, contact support with the X-Request-Id.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    ServiceUnavailable:
      description: The API or quota verification service is temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/service_unavailable
            title: Service Unavailable
            status: 503
            detail: >-
              API key verification is temporarily unavailable. Please retry
              shortly.
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#retry-guidance
            suggested_action: >-
              The API is temporarily unavailable. Retry with exponential
              backoff. If it persists, contact team@sharpe.ai with the
              X-Request-Id.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your API key as a Bearer token in the Authorization header:
        `Authorization: Bearer sk_live_...`
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternatively, pass your API key via the X-API-Key header.

````

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