Alphanume Market Structure API

openapi: 3.2.0
info:
  contact:
    url: https://alphanume.com
  description: 'Point-in-time, survivorship-aware datasets for US equities and options research. Every response is JSON: {"count": N, "data": [...]} (paginated endpoints add has_more and next_cursor). Dates are always YYYY-MM-DD. Access: every dataset requires an Alphanume Pro API key (the Free plan is retired as of September 6, 2026). A 403 error with code PRO_SUBSCRIPTION_REQUIRED or DATE_RANGE_RESTRICTED means the key''s plan does not cover the request -- it does not mean the data is missing. Authentication: send your API key in the X-API-Key header (or Authorization: Bearer). Rate limit: 600 requests/minute. Keys come with a Pro subscription at https://alphanume.com/pricing. The same datasets are available as MCP tools at https://mcp.alphanume.com/mcp.'
  title: Alphanume Market Structure API
  version: 1.1.0
servers:
- url: https://api.alphanume.com
security:
- ApiKeyHeader: []
- BearerKey: []
tags:
- name: Market Structure
paths:
  /v1/market-structure/sec-suspensions:
    get:
      description: 'SEC trading suspensions: every Section 12(k) order halting trading in a stock,

        1995 to today -- the terminal-risk tape for dying OTC and small-cap names. One row

        per (order, issuer): who was halted, when trading stopped, when it could legally

        resume (first NYSE session after the order terminates), the cited reason normalized

        to a 4-value taxonomy, listing venue, and the order PDF URL.


        Bulk delinquency orders (2013-2021) name up to ~55 issuers under one release_number

        -- use issuer_count/issuer_index to collapse rows back to order level. Ticker is

        NULL where the order states none (most pre-2022 rows). resumption_at is when

        trading MAY resume; many suspended names never quote again. The SEC''s suspension

        output collapsed after 2021: expect only a handful of orders per year since.


        Requires an Alphanume Pro API key. A 403 PRO_SUBSCRIPTION_REQUIRED or

        DATE_RANGE_RESTRICTED error means the key''s plan does not cover the request --

        it does not mean the data is missing. Note the newest event may be months old:

        short date windows can legitimately be empty on this dataset.'
      operationId: get_sec_trading_suspensions
      parameters:
      - description: Ticker symbol filter, e.g. 'AAPL'. Case-insensitive.
        in: query
        name: ticker
        required: false
        schema:
          type: string
      - description: SEC CIK number (digits only) to filter by issuer. The only survivorship-proof id for dead shells; NULL on most bulk-order rows.
        in: query
        name: cik
        required: false
        schema:
          type: string
      - description: Exchange Act release number, e.g. '34-92362' (a bare '92362' is normalized). One bulk order returns one row per named issuer.
        in: query
        name: release_number
        required: false
        schema:
          type: string
      - description: 'Why the SEC suspended trading: delinquent_filings, market_manipulation, accuracy_adequacy_of_information, or other.'
        in: query
        name: cited_reason
        required: false
        schema:
          type: string
      - description: Case-insensitive substring match on the issuer name -- the only handle on rows with no ticker.
        in: query
        name: issuer_name
        required: false
        schema:
          type: string
      - description: 'true/false: whether the date trading could legally resume is in the past. Resumption is permission, not evidence of quoting (Rule 15c2-11).'
        in: query
        name: has_resumed
        required: false
        schema:
          type: string
      - description: true = single-issuer orders only (the modern manipulation cases); false = bulk multi-issuer orders only.
        in: query
        name: single_issuer
        required: false
        schema:
          type: string
      - description: 'YYYY-MM-DD: rows whose suspension window covers this date -- ''which stocks were untradeable on day X''. Not expressible via the release-date window.'
        in: query
        name: active_on
        required: false
        schema:
          type: string
      - description: Exact date, YYYY-MM-DD. Cannot be combined with the date range parameters.
        in: query
        name: date
        required: false
        schema:
          type: string
      - description: Start of date range, inclusive (YYYY-MM-DD).
        in: query
        name: date_gte
        required: false
        schema:
          type: string
      - description: End of date range, inclusive (YYYY-MM-DD).
        in: query
        name: date_lte
        required: false
        schema:
          type: string
      - description: Start of date range, exclusive (YYYY-MM-DD).
        in: query
        name: date_gt
        required: false
        schema:
          type: string
      - description: End of date range, exclusive (YYYY-MM-DD).
        in: query
        name: date_lt
        required: false
        schema:
          type: string
      - description: YYYY-MM-DD, on last_updated -- rows touched by the resumption sweep since this date.
        in: query
        name: updated_since
        required: false
        schema:
          type: string
      - description: 'Pagination: ''date'' from next_cursor (send all three cursor params together).'
        in: query
        name: cursor_date
        required: false
        schema:
          type: string
      - description: 'Pagination: ''release_number'' from next_cursor.'
        in: query
        name: cursor_release_number
        required: false
        schema:
          type: string
      - description: 'Pagination: ''issuer_index'' from next_cursor.'
        in: query
        name: cursor_issuer_index
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEnvelope'
          description: Matching rows.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
      summary: 'SEC trading suspensions: every Section 12(k) order halting trading in a stock,'
      tags:
      - Market Structure
components:
  responses:
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: 'PRO_SUBSCRIPTION_REQUIRED: the key''s plan does not include API access; every endpoint requires an active Pro subscription. DATE_RANGE_RESTRICTED: a legacy free-tier key asked for dates outside its window. In both cases the data is not missing.'
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Missing or unrecognized API key.
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Invalid or conflicting query parameters.
    RateLimited:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Rate limit exceeded (600/min); the body carries retry_after_seconds.
  schemas:
    PaginatedEnvelope:
      properties:
        count:
          type: integer
        data:
          items:
            type: object
          type: array
        has_more:
          type: boolean
        next_cursor:
          description: 'Keyset cursor: pass its fields back as the cursor_* query parameters to fetch the next page.'
          type:
          - object
          - 'null'
      required:
      - count
      - data
      - has_more
      - next_cursor
      type: object
    Error:
      additionalProperties: true
      properties:
        error: {}
      type: object
  securitySchemes:
    ApiKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    BearerKey:
      scheme: bearer
      type: http
externalDocs:
  description: MCP server exposing these datasets as tools (OAuth or X-API-Key).
  url: https://mcp.alphanume.com/mcp