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

# Short Interest History

> Returns one company's daily short interest over a window: shares sold short, days
to cover, the cost to borrow, the shares still available to borrow and the short
score, one row per trading day, oldest first.

One company per request, keyed by RavenPack entity ID. Pick the figures with
`metrics`; the fields of any other metric are left out of every row, and a field
is `null` on a day its metric has no value. Results are
paged: send back `pagination.cursor` with the same request to get the next page,
and keep going until `pagination.has_cursor` is false. A company with no listing
with short interest coverage comes back with an empty `results` and no
`metadata.listing`. A plan that does not include short interest data gets a 403.



## OpenAPI

````yaml /api-rest/openapi/openapi_structured_data.json post /v1/short-interest/history/query
openapi: 3.1.0
info:
  title: Bigdata Structured Data API
  description: Bigdata API documentation
  version: 1.0.0
servers:
  - url: https://api.bigdata.com/
security:
  - ApiKeyAuth: []
tags:
  - name: Market Data
    description: >-
      Market data endpoints including intraday prices, daily prices, price
      changes, and real-time quotes
  - name: Analyst Estimates
    description: >-
      Analyst estimates and ratings including analyst ratings, estimates, target
      prices, and earnings surprises
  - name: Financials & Ratios
    description: >-
      Financial statements and ratios including balance sheet, income statement,
      cash flow statement, key metrics TTM, and company ratios TTM
  - name: Company & Events
    description: >-
      Company information and events including company profile and events
      calendar
  - name: Fund Holdings
    description: >-
      Institutional fund holdings from SEC 13F filings including fund holdings
      and stock fund holdings
  - name: Knowledge Graph
    description: Corporate ownership and hierarchy data.
  - name: Private Markets
    description: >-
      Private company data including profile, headquarters, funding totals and
      valuation
  - name: Fixed Income
    description: 'Bond reference data: the bonds a company has issued and their terms'
paths:
  /v1/short-interest/history/query:
    post:
      tags:
        - Market Data
      summary: Short Interest History
      description: >-
        Returns one company's daily short interest over a window: shares sold
        short, days

        to cover, the cost to borrow, the shares still available to borrow and
        the short

        score, one row per trading day, oldest first.


        One company per request, keyed by RavenPack entity ID. Pick the figures
        with

        `metrics`; the fields of any other metric are left out of every row, and
        a field

        is `null` on a day its metric has no value. Results are

        paged: send back `pagination.cursor` with the same request to get the
        next page,

        and keep going until `pagination.has_cursor` is false. A company with no
        listing

        with short interest coverage comes back with an empty `results` and no

        `metadata.listing`. A plan that does not include short interest data
        gets a 403.
      operationId: Short_Interest_History_v1_short_interest_history_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShortInterestHistoryQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShortInterestHistoryResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
components:
  schemas:
    ShortInterestHistoryQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/SingleIdentifier'
          description: The company, by RavenPack entity id.
        from_date:
          type: string
          format: date
          title: From Date
          description: First day of the window, as `YYYY-MM-DD`.
          examples:
            - '2026-01-02'
        to_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: To Date
          description: >-
            Last day of the window, as `YYYY-MM-DD`. Defaults to today, so the
            window ends on the last day with data.
          examples:
            - '2026-06-30'
        metrics:
          anyOf:
            - items:
                $ref: '#/components/schemas/ShortInterestMetric'
              type: array
              minItems: 1
            - type: 'null'
          title: Metrics
          description: >-
            Which metrics the rows carry; every metric when left out.
            `short_interest` fills `shares_short`, `shares_short_value_usd` and
            `percent_of_free_float`; `cost_to_borrow` fills `cost_to_borrow` and
            `cost_to_borrow_new_loans`; `shares_available_to_borrow` fills
            `shares_available_to_borrow` and `shares_available_to_borrow_count`;
            the others fill the field of the same name.
          examples:
            - - short_interest
              - days_to_cover
        days_to_cover_period:
          $ref: '#/components/schemas/DaysToCoverPeriod'
          default: 3M
        limit:
          type: integer
          maximum: 1000
          minimum: 1
          title: Limit
          description: Trading days per page, from 1 to 1000. A year is about 252.
          default: 250
          examples:
            - 250
        cursor:
          anyOf:
            - type: string
              maxLength: 1024
            - type: 'null'
          title: Cursor
          description: >-
            Token for the next page. Send back `pagination.cursor` from the
            previous response, unchanged and with the same identifier, window,
            metrics and `days_to_cover_period`; `limit` may differ. Omit it for
            the first page.
      additionalProperties: false
      type: object
      required:
        - identifier
        - from_date
      title: ShortInterestHistoryQuery
      example:
        from_date: '2026-01-02'
        identifier:
          type: rp_entity_id
          value: 86170D
        metrics:
          - short_interest
          - days_to_cover
        to_date: '2026-06-30'
    ShortInterestHistoryResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/ShortInterestDay'
          type: array
          title: Results
          description: >-
            One row per trading day with data in the page, oldest first. A
            response holds one page; send `pagination.cursor` back as `cursor`
            for the next.
        errors:
          anyOf:
            - items:
                $ref: '#/components/schemas/ErrorDetail'
              type: array
            - type: 'null'
          title: Errors
        metadata:
          $ref: '#/components/schemas/ShortInterestHistoryMetadata'
        pagination:
          anyOf:
            - $ref: '#/components/schemas/Pagination'
            - type: 'null'
        sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/Source'
              type: array
            - type: 'null'
          title: Sources
          description: >-
            Structured-data sources the response was built from, one entry per
            source. Empty when no catalog source contributed.
        usage:
          anyOf:
            - $ref: '#/components/schemas/Usage'
            - type: 'null'
          description: >-
            Tokens the request consumed, per content tier. Returned only to
            callers billed in tokens.
      type: object
      required:
        - results
        - metadata
      title: ShortInterestHistoryResponse
    BadRequestError:
      properties:
        statusCode:
          type: integer
          const: 400
          title: Statuscode
          default: 400
        message:
          type: string
          title: Message
      type: object
      required:
        - message
      title: BadRequestError
      description: Bad Request Error
      example:
        message: Bad Request Error
        statusCode: 400
    TooManyRequestsError:
      properties:
        statusCode:
          type: integer
          const: 429
          title: Statuscode
          default: 429
        message:
          type: string
          title: Message
      type: object
      required:
        - message
      title: TooManyRequestsError
      description: Too many requests. Please try again later.
      example:
        message: Too many requests. Please try again later.
        statusCode: 429
    InternalServerError:
      properties:
        statusCode:
          type: integer
          const: 500
          title: Statuscode
          default: 500
        message:
          type: string
          title: Message
      type: object
      required:
        - message
      title: InternalServerError
      description: Internal Server Error
      example:
        message: Internal Server Error
        statusCode: 500
    SingleIdentifier:
      properties:
        type:
          $ref: '#/components/schemas/IdentifierTypeEnum'
          description: >-
            Object specifying which identifier you are using to request the
            data. You must supply one type and its corresponding value. Only one
            identifier should be provided per request.
          examples:
            - rp_entity_id
        value:
          type: string
          maxLength: 6
          minLength: 6
          title: Value
          description: >-
            Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to
            uniquely reference entities such as companies. This identifier is a
            6-character alphanumeric code (letters and numbers only). Example:
            Alphabet Inc. (`4A6F00`)
          examples:
            - 4A6F00
      type: object
      required:
        - type
        - value
      title: SingleIdentifier
    ShortInterestMetric:
      type: string
      enum:
        - short_interest
        - days_to_cover
        - cost_to_borrow
        - shares_available_to_borrow
        - short_score
      title: ShortInterestMetric
      description: A group of figures the series can carry.
    DaysToCoverPeriod:
      type: string
      enum:
        - 1W
        - 2W
        - 1M
        - 3M
      title: DaysToCoverPeriod
      description: The trailing window whose average daily volume days to cover divides by.
    ShortInterestDay:
      properties:
        date:
          type: string
          format: date
          title: Date
          description: The trading day the row is for.
          examples:
            - '2026-11-13'
        shares_short:
          anyOf:
            - type: number
            - type: 'null'
          title: Shares Short
          description: Shares sold short and not yet bought back.
          examples:
            - 3276922
        shares_short_value_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Shares Short Value Usd
          description: Market value of the shares sold short, in US dollars.
          examples:
            - 2007540537
        percent_of_free_float:
          anyOf:
            - type: number
            - type: 'null'
          title: Percent Of Free Float
          description: Shares sold short as a percentage of the shares that trade freely.
          examples:
            - 2.086555
        days_to_cover:
          anyOf:
            - type: number
            - type: 'null'
          title: Days To Cover
          description: >-
            Shares sold short divided by the average daily volume over
            `days_to_cover_period`.
          examples:
            - 2.0307
        cost_to_borrow:
          anyOf:
            - type: number
            - type: 'null'
          title: Cost To Borrow
          description: >-
            Yearly fee for borrowing the shares, in percent, averaged over all
            open loans.
          examples:
            - 0.44
        cost_to_borrow_new_loans:
          anyOf:
            - type: number
            - type: 'null'
          title: Cost To Borrow New Loans
          description: >-
            Yearly fee for borrowing the shares, in percent, on loans opened
            that day.
          examples:
            - 0.51
        shares_available_to_borrow:
          anyOf:
            - type: number
            - type: 'null'
          title: Shares Available To Borrow
          description: >-
            Shares still available to borrow, as a percentage of the shares sold
            short.
          examples:
            - 1918
        shares_available_to_borrow_count:
          anyOf:
            - type: number
            - type: 'null'
          title: Shares Available To Borrow Count
          description: >-
            Shares still available to borrow, not counting shares already on
            loan.
          examples:
            - 68799744
        short_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Short Score
          description: >-
            A ranking of short-selling pressure across all covered stocks, from
            0 to 100.
          examples:
            - 32.2402
      type: object
      required:
        - date
      title: ShortInterestDay
      description: >-
        One trading day of a company's short interest series.


        A field is left out when its metric was not asked for, and is null when
        its metric

        has no value that day.
    ErrorDetail:
      properties:
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
      type: object
      title: ErrorDetail
    ShortInterestHistoryMetadata:
      properties:
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
        timestamp:
          type: string
          title: Timestamp
        rp_entity_id:
          type: string
          maxLength: 6
          minLength: 6
          title: Rp Entity Id
          description: The RavenPack entity ID of the company requested.
          examples:
            - 4A6F00
        from_date:
          type: string
          format: date
          title: From Date
          description: First day of the window.
        to_date:
          type: string
          format: date
          title: To Date
          description: Last day of the window, filled in when the request left it out.
        metrics:
          items:
            $ref: '#/components/schemas/ShortInterestMetric'
          type: array
          title: Metrics
          description: >-
            The metrics the rows carry. The fields of any other metric are left
            out of every row.
        days_to_cover_period:
          $ref: '#/components/schemas/DaysToCoverPeriod'
          description: The window days to cover was measured against.
        listing:
          anyOf:
            - $ref: '#/components/schemas/ShortInterestListing'
            - type: 'null'
          description: >-
            The listing the series is for. Absent when the company has no
            listing with short interest coverage, and `results` is then empty.
      type: object
      required:
        - rp_entity_id
        - from_date
        - to_date
        - metrics
        - days_to_cover_period
      title: ShortInterestHistoryMetadata
    Pagination:
      properties:
        cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Cursor
          description: Next page token or URL to retrieve the next page of results.
          examples:
            - 00000DexaRK4NT6t
        has_cursor:
          type: boolean
          title: Has Cursor
          description: Whether there are more pages available after this one.
          default: false
          examples:
            - true
      type: object
      title: Pagination
      description: Common pagination response for endpoints that support pagination.
    Source:
      properties:
        id:
          type: string
          title: Id
          description: Content catalog identifier of the source.
          examples:
            - CA9FA3
        name:
          type: string
          title: Name
          description: Catalog name of the dataset the data came from.
          examples:
            - Corporate Fundamentals
      type: object
      required:
        - id
        - name
      title: Source
      description: >-
        A content catalog source that contributed data to a structured-data
        response.
    Usage:
      additionalProperties:
        type: integer
      type: object
      title: Usage
      description: >-
        Public structured-data usage for a request, aggregated per content tier.


        A flat object keyed per content tier, where each key is derived from the

        content tier identifier by dropping the ``content-`` prefix and
        appending

        ``_tokens`` (e.g. ``corporate-fundamentals`` ->

        ``corporate_fundamentals_tokens``). It is sparse: only tiers with
        non-zero

        tokens appear, and an absent key means zero tokens for that tier.
    IdentifierTypeEnum:
      type: string
      enum:
        - rp_entity_id
      title: IdentifierTypeEnum
    ShortInterestListing:
      properties:
        mic:
          type: string
          title: Mic
          description: >-
            Operating market identifier code of the exchange the listing trades
            on.
          examples:
            - XNYS
        ticker:
          type: string
          title: Ticker
          description: Ticker of the listing on that exchange.
          examples:
            - SPOT
      type: object
      required:
        - mic
        - ticker
      title: ShortInterestListing
      description: The listing a company's short interest is measured on.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````

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