Arbitron Platform API

openapi: 3.2.0
info:
  title: Arbitron App Platform API
  version: 1.0.0
  contact:
    name: Arbitron
    url: https://arbitron.app/developers
    email: support@arbitron.app
  termsOfService: https://arbitron.app/terms
  description: 'Operations tagged Platform across 2 of this provider''s published API definitions: arbitron-openapi.json, arbitron-app-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://arbitron.app
  description: Production
security:
- ApiKey: []
tags:
- name: Platform
  description: Discovery and your key's usage. Authentication, rate limits, caching, errors and versioning are covered in the introduction above.
paths:
  /api/v1:
    get:
      tags:
      - Platform
      summary: Where everything is
      description: Anonymous. Links to the docs, the OpenAPI document, `llms.txt`, the MCP server and the plans, plus the endpoint list with the scope each one needs.
      operationId: discover
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoveryResponse'
    servers:
    - url: https://arbitron.app
      description: Production
  /api/v1/usage:
    get:
      tags:
      - Platform
      summary: This key's usage and limits
      description: The plan behind the key, the month and minute windows, and what the plan includes (history depth, delay, commercial use).
      operationId: getUsage
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiEnvelopeOfUsageResponse'
              example:
                data:
                  plan: trade
                  key_prefix: arb_live_DPxk…
                  scopes:
                  - funding:read
                  - history:read
                  - spreads:read
                  - listings:read
                  - usage:read
                  - mcp:read
                  month:
                    used: 1842
                    limit: 100000
                    remaining: 98158
                    resets_at: '2026-10-01T00:00:00Z'
                  minute:
                    used: 3
                    limit: 120
                    remaining: 117
                    resets_at: '2026-09-21T12:01:00Z'
                  history_days: 180
                  delay_seconds: 0
                  commercial_use: false
                  upgrade_url: https://arbitron.app/developers#plans
                meta:
                  as_of: '2026-09-21T12:00:04Z'
                  delayed_seconds: 0
                  source: arbitron.app
                  url: https://arbitron.app/settings/api?utm_source=api
    servers:
    - url: https://arbitron.app
      description: Production
components:
  schemas:
    DiscoveryEndpoint:
      required:
      - method
      - path
      - scope
      - summary
      type: object
      properties:
        method:
          type: string
        path:
          type: string
        scope:
          type:
          - 'null'
          - string
        summary:
          type: string
    UsageResponse:
      required:
      - plan
      - key_prefix
      - scopes
      - month
      - minute
      - history_days
      - delay_seconds
      - commercial_use
      - upgrade_url
      type: object
      properties:
        plan:
          type: string
        key_prefix:
          type: string
        scopes:
          type: array
          items:
            type: string
        month:
          $ref: '#/components/schemas/UsageWindow'
        minute:
          $ref: '#/components/schemas/UsageWindow'
        history_days:
          type:
          - 'null'
          - integer
          format: int32
        delay_seconds:
          type: integer
          format: int32
        commercial_use:
          type: boolean
        upgrade_url:
          type:
          - 'null'
          - string
    ApiMeta:
      required:
      - as_of
      - delayed_seconds
      - source
      - url
      type: object
      properties:
        as_of:
          type: string
          format: date-time
        delayed_seconds:
          type: integer
          format: int32
        source:
          type: string
        url:
          type: string
        count:
          type:
          - 'null'
          - integer
          format: int32
        total:
          type:
          - 'null'
          - integer
          format: int32
        next_cursor:
          type:
          - 'null'
          - string
        withheld:
          type:
          - 'null'
          - integer
          format: int32
    UsageWindow:
      required:
      - used
      - limit
      - remaining
      - resets_at
      type: object
      properties:
        used:
          type: integer
          format: int64
        limit:
          type: integer
          format: int64
        remaining:
          type: integer
          format: int64
        resets_at:
          type: string
          format: date-time
    ApiEnvelopeOfUsageResponse:
      required:
      - data
      - meta
      type: object
      properties:
        data:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/UsageResponse'
        meta:
          $ref: '#/components/schemas/ApiMeta'
    DiscoveryResponse:
      required:
      - name
      - version
      - description
      - docs_url
      - openapi_url
      - reference_url
      - llms_url
      - mcp_url
      - plans_url
      - auth
      - endpoints
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        description:
          type: string
        docs_url:
          type: string
        openapi_url:
          type: string
        reference_url:
          type: string
        llms_url:
          type: string
        mcp_url:
          type: string
        plans_url:
          type: string
        auth:
          $ref: '#/components/schemas/DiscoveryAuth'
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/DiscoveryEndpoint'
    DiscoveryAuth:
      required:
      - type
      - header
      - key_prefix
      - get_key_url
      type: object
      properties:
        type:
          type: string
        header:
          type: string
        key_prefix:
          type: string
        get_key_url:
          type: string
  securitySchemes:
    ApiKey:
      type: http
      description: Your API key as a bearer token. The X-Api-Key header is accepted too.
      scheme: bearer
      bearerFormat: arb_live_<43 chars>_<6 chars>
x-refined-from:
- arbitron-openapi.json
- arbitron-app-openapi.json