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

# crypto.derivatives.snapshot

> Open interest and funding of a perpetual contract on one exchange.



## OpenAPI

````yaml api-reference/openapi/v2.yaml POST /v2/ops/crypto.derivatives.snapshot
openapi: 3.1.0
info:
  description: >-
    Fixed, versioned, provider-independent methods over AgentKey's upstream
    catalog. Each method has a stable name, input schema and output schema; the
    server picks the upstream provider, fails over, normalizes fields and
    refunds failed attempts. Every response names the provider that served it,
    the credits charged and every attempt made.
  title: AgentKey Scenario Methods
  version: '2'
servers:
  - url: https://api.agentkey.app
security: []
paths:
  /v2/ops/crypto.derivatives.snapshot:
    post:
      tags:
        - crypto
      summary: Open interest and funding of a perpetual contract on one exchange.
      description: >-
        Returns the current perpetual-futures snapshot of one base asset (BTC,
        ETH …) on one exchange: open interest in USD and contracts, funding rate
        and next settlement, mark and index price. The USDT-quoted perpetual is
        used.


        Fixed price: 3.6 credits per successful call, whichever provider serves
        it.
      operationId: crypto_derivatives_snapshot
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                exchange:
                  default: binance
                  description: Exchange to read the contract from.
                  enum:
                    - binance
                    - okx
                    - bybit
                    - bitget
                    - htx
                    - bitfinex
                    - bitmex
                    - hyperliquid
                  type: string
                fields:
                  $ref: '#/components/schemas/FieldsProjection'
                include_raw:
                  $ref: '#/components/schemas/IncludeRaw'
                provider:
                  $ref: '#/components/schemas/ProviderShorthand'
                routing:
                  $ref: '#/components/schemas/Routing'
                symbol:
                  description: Base asset ticker, e.g. BTC. Case-insensitive.
                  type: string
              required:
                - symbol
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DerivativesSnapshotEnvelope'
          description: Success envelope
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/InsufficientCredits'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '502':
          $ref: '#/components/responses/UpstreamFailed'
        '504':
          $ref: '#/components/responses/Timeout'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    FieldsProjection:
      description: >-
        Projection: keep only these dotted paths of data, e.g. ["items.id",
        "items.text"].
      items:
        type: string
      type: array
    IncludeRaw:
      default: false
      description: >-
        Attach the raw upstream payload as `raw` (not a stable contract;
        truncated above 256 KB).
      type: boolean
    ProviderShorthand:
      description: Shorthand for routing.only = [provider].
      type: string
    Routing:
      additionalProperties: false
      description: >-
        Provider routing override. order: try these providers first; only:
        restrict to these (equivalent to pinning); allow_fallbacks: false tries
        only the first eligible provider.
      properties:
        allow_fallbacks:
          default: true
          description: false = try only the first eligible provider.
          type: boolean
        only:
          description: Restrict to these providers.
          items:
            type: string
          type: array
        order:
          description: Providers to try first, in order.
          items:
            type: string
          type: array
        strategy:
          default: auto
          description: >-
            How eligible providers are ordered. auto = the method's curated
            order. fastest / stable / popular are specified but not implemented
            yet (400 until then). The price is fixed whatever the strategy;
            mutually exclusive with order.
          enum:
            - auto
          type: string
      type: object
    DerivativesSnapshotEnvelope:
      allOf:
        - $ref: '#/components/schemas/Envelope'
        - properties:
            data:
              $ref: '#/components/schemas/DerivativesSnapshot'
          type: object
      description: Success envelope whose data is a DerivativesSnapshot.
    Envelope:
      description: Success envelope. `data` is the method's output object.
      properties:
        attempts:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
        credits_charged:
          description: Credits charged for this call (the method's fixed price).
          type: number
        data:
          description: Method output (typed per method).
        op:
          description: Method name.
          type: string
        op_version:
          description: Method version that served the call.
          type: integer
        provider:
          description: Provider that actually served the call.
          type: string
        raw:
          description: Upstream payload, only with include_raw=true. Not a stable contract.
        raw_truncated:
          type: boolean
        request_id:
          description: Correlation id; quote it in support requests.
          type: string
        took_ms:
          type: integer
        unsupported_fields:
          description: >-
            Output paths this provider structurally does not supply; such fields
            are null for a different reason than 'missing on this record'.
          items:
            type: string
          type: array
      required:
        - op
        - op_version
        - provider
        - request_id
        - credits_charged
        - took_ms
        - attempts
        - unsupported_fields
        - data
      type: object
    DerivativesSnapshot:
      additionalProperties: false
      description: Current perpetual-futures state of one symbol on one exchange.
      properties:
        as_of:
          description: Time of the open-interest reading, RFC 3339 UTC.
          format: date-time
          type:
            - string
            - 'null'
        exchange:
          description: Exchange slug the figures come from.
          type:
            - string
            - 'null'
        funding:
          properties:
            index_price:
              description: Index price.
              type:
                - number
                - 'null'
            interval:
              description: Funding interval (8h).
              type:
                - string
                - 'null'
            mark_price:
              description: Mark price.
              type:
                - number
                - 'null'
            next_at:
              description: Next funding settlement, RFC 3339 UTC.
              format: date-time
              type:
                - string
                - 'null'
            rate:
              description: Current funding rate as a decimal (0.0001 = 0.01%).
              type:
                - number
                - 'null'
          required:
            - rate
            - interval
            - next_at
            - mark_price
            - index_price
          type: object
        liquidations_24h:
          properties:
            long_usd:
              description: Long liquidations over the last 24 hours in USD.
              type:
                - number
                - 'null'
            short_usd:
              description: Short liquidations over the last 24 hours in USD.
              type:
                - number
                - 'null'
            total_usd:
              description: Liquidations over the last 24 hours in USD.
              type:
                - number
                - 'null'
          required:
            - total_usd
            - long_usd
            - short_usd
          type: object
        long_short_ratio:
          description: >-
            Long/short account ratio (1.5 = 60% long) when the provider reports
            it.
          type:
            - number
            - 'null'
        open_interest:
          properties:
            amount:
              description: Open interest in base-asset units / contracts.
              type:
                - number
                - 'null'
            usd:
              description: Open interest in USD.
              type:
                - number
                - 'null'
          required:
            - usd
            - amount
          type: object
        pair:
          description: Contract pair as the exchange names it (BTC/USDT:USDT).
          type:
            - string
            - 'null'
        symbol:
          description: Base asset ticker (BTC).
          type: string
        volume_24h:
          description: 24-hour contract volume in USD when reported.
          type:
            - number
            - 'null'
      required:
        - symbol
        - exchange
        - pair
        - open_interest
        - funding
        - long_short_ratio
        - volume_24h
        - liquidations_24h
        - as_of
      type: object
    ErrorEnvelope:
      properties:
        attempts:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
        code:
          type: integer
        error:
          description: Human-readable message.
          type: string
        error_type:
          description: >-
            validation | not_found | rate_limit | timeout | insufficient_credits
            | upstream_unauthorized | upstream_unavailable | provider_error
          type: string
        op:
          description: Method name.
          type: string
        request_id:
          description: Correlation id.
          type: string
      required:
        - error
        - code
        - error_type
      type: object
    Attempt:
      description: >-
        One upstream try. Present on success and failure so a failover is never
        invisible.
      properties:
        error_type:
          description: >-
            validation | not_found | rate_limit | timeout |
            upstream_unauthorized | upstream_unavailable | provider_error
          type: string
        provider:
          description: Provider slug.
          type: string
        refunded:
          description: true when the reservation for this attempt was refunded.
          type: boolean
        status:
          description: HTTP status AgentKey mapped this attempt to (200 on success).
          type: integer
        took_ms:
          type: integer
        tool:
          description: Registry tool name (Provider/operation) that was called.
          type: string
        upstream_status:
          description: The provider's real HTTP status; absent when nothing was received.
          type: integer
      required:
        - provider
        - tool
        - status
        - took_ms
      type: object
  responses:
    ValidationError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Validation error (unknown field, bad cursor, bad routing)
    InsufficientCredits:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Insufficient credits
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Not found (method, or upstream object)
    RateLimited:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Rate limited upstream
    UpstreamFailed:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: All providers failed
    Timeout:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Timed out
  securitySchemes:
    ApiKeyAuth:
      description: AgentKey API key (ak_…).
      scheme: bearer
      type: http

````

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