> ## 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

> Returns how much of a company's stock is sold short on the latest day with data, how
quickly short sellers could exit, what borrowing the shares costs, how the position
changed over 5 days to a year, and where each figure stands against its past year.

Request up to 50 companies at a time by RavenPack entity ID. `results` is keyed by
entity ID in request order, `null` for a company with no short interest data;
`metadata.listings` names the listing each company's figures are for, `null` when
the company has no listing with short interest coverage. 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/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/query:
    post:
      tags:
        - Market Data
      summary: Short Interest
      description: >-
        Returns how much of a company's stock is sold short on the latest day
        with data, how

        quickly short sellers could exit, what borrowing the shares costs, how
        the position

        changed over 5 days to a year, and where each figure stands against its
        past year.


        Request up to 50 companies at a time by RavenPack entity ID. `results`
        is keyed by

        entity ID in request order, `null` for a company with no short interest
        data;

        `metadata.listings` names the listing each company's figures are for,
        `null` when

        the company has no listing with short interest coverage. A plan that
        does not

        include short interest data gets a 403.
      operationId: Short_Interest_v1_short_interest_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShortInterestQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShortInterestResponse'
        '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:
    ShortInterestQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/ShortInterestIdentifier'
          description: The companies, by RavenPack entity id.
      additionalProperties: false
      type: object
      required:
        - identifier
      title: ShortInterestQuery
      example:
        identifier:
          type: rp_entity_id
          value:
            - 86170D
            - D8442A
    ShortInterestResponse:
      properties:
        results:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/CompanyShortInterest'
              - type: 'null'
          type: object
          title: Results
          description: >-
            Each company's short interest keyed by entity id, one key per
            distinct id sent, upper-cased, in the order they were sent. `null`
            for a company with no short interest data.
        errors:
          anyOf:
            - items:
                $ref: '#/components/schemas/ErrorDetail'
              type: array
            - type: 'null'
          title: Errors
        metadata:
          $ref: '#/components/schemas/ShortInterestMetadata'
        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: ShortInterestResponse
    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
    ShortInterestIdentifier:
      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:
          anyOf:
            - type: string
              maxLength: 6
              minLength: 6
              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
            - items:
                type: string
                maxLength: 6
                minLength: 6
                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: array
              maxItems: 50
              minItems: 1
          title: Value
          description: >-
            One RavenPack entity id, or a list of 1 to 50. An id sent twice is
            answered once.
          examples:
            - - 86170D
              - D8442A
      type: object
      required:
        - type
        - value
      title: ShortInterestIdentifier
    CompanyShortInterest:
      properties:
        short_position:
          $ref: '#/components/schemas/ShortPosition'
          description: The short position on the latest day with data.
        intraday_estimate:
          anyOf:
            - $ref: '#/components/schemas/IntradayShortInterestEstimate'
            - type: 'null'
          description: >-
            The latest estimate during the trading day, when it is newer than
            the short position. Left out when there is none newer: the data
            provider makes no intraday estimate for the listing, its latest is
            from the same day as the short position (over a weekend, say), or it
            could not be read in time.
        change_percent:
          $ref: '#/components/schemas/ShortInterestChangePercent'
          description: The change in shares sold short over 5 days to a year.
          default: {}
        compared_with_past_year:
          $ref: '#/components/schemas/ComparedWithPastYear'
          description: >-
            Each figure today, three months and a year ago, and its range over
            the past year.
      type: object
      required:
        - short_position
        - compared_with_past_year
      title: CompanyShortInterest
      description: >-
        One company's short interest: the short position, how it changed, and
        its past year.
    ErrorDetail:
      properties:
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
      type: object
      title: ErrorDetail
    ShortInterestMetadata:
      properties:
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
        timestamp:
          type: string
          title: Timestamp
        listings:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/ShortInterestListingWithIsin'
              - type: 'null'
          type: object
          title: Listings
          description: >-
            The listing each company's figures are for, keyed by entity id in
            the order `results` is. `null` when the company has no listing with
            short interest coverage, which tells it apart from a covered company
            with no data: both are `null` in `results`.
          examples:
            - 86170D:
                mic: XNYS
                ticker: SPOT
      type: object
      required:
        - listings
      title: ShortInterestMetadata
    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
    ShortPosition:
      properties:
        as_of:
          type: string
          format: date
          title: As Of
          description: The trading day these figures describe.
          examples:
            - '2026-11-16'
        shares_short:
          anyOf:
            - type: number
            - type: 'null'
          title: Shares Short
          description: Shares sold short and not yet bought back.
          examples:
            - 3154194
        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:
            - 1929515248
        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.008409
        rank_past_year:
          anyOf:
            - type: integer
            - type: 'null'
          title: Rank Past Year
          description: >-
            Share of the past year's trading days with lower short interest than
            today, from 0 (lowest of the year) to 100 (highest).
          examples:
            - 2
        days_to_cover:
          anyOf:
            - type: number
            - type: 'null'
          title: Days To Cover
          description: >-
            Shares sold short divided by the average daily volume over three
            months.
          examples:
            - 1.9891
        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.45
        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.5515
        new_loans_cost_more:
          anyOf:
            - type: boolean
            - type: 'null'
          title: New Loans Cost More
          description: Whether new loans cost markedly more than the average open loan.
          examples:
            - false
        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:
            - 1885.64
        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:
            - 67851982
        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:
            - 31.9636
      type: object
      required:
        - as_of
      title: ShortPosition
      description: >-
        The short position on the latest day with data. A figure with no value
        is left out.
    IntradayShortInterestEstimate:
      properties:
        as_of:
          type: string
          format: date-time
          title: As Of
          description: When the estimate took effect, in UTC.
          examples:
            - '2026-11-20T10:46:47Z'
        shares_short:
          anyOf:
            - type: number
            - type: 'null'
          title: Shares Short
          description: Estimated shares sold short and not yet bought back.
          examples:
            - 42168567
        percent_of_free_float:
          anyOf:
            - type: number
            - type: 'null'
          title: Percent Of Free Float
          description: >-
            Estimated shares sold short as a percentage of the shares that trade
            freely.
          examples:
            - 2.561525
      type: object
      required:
        - as_of
      title: IntradayShortInterestEstimate
      description: >-
        The data provider's latest estimate of the short position during the
        trading

        day. A figure with no value is left out.
    ShortInterestChangePercent:
      properties:
        5D:
          anyOf:
            - type: number
            - type: 'null'
          title: 5D
          description: Over the last 5 days.
          examples:
            - -14.8
        1M:
          anyOf:
            - type: number
            - type: 'null'
          title: 1M
          description: Over the last month.
          examples:
            - -28.9
        3M:
          anyOf:
            - type: number
            - type: 'null'
          title: 3M
          description: Over the last 3 months.
          examples:
            - -52.9
        6M:
          anyOf:
            - type: number
            - type: 'null'
          title: 6M
          description: Over the last 6 months.
          examples:
            - -53.2
        1Y:
          anyOf:
            - type: number
            - type: 'null'
          title: 1Y
          description: Over the last year.
          examples:
            - -56.4
      type: object
      title: ShortInterestChangePercent
      description: >-
        Percentage change in shares sold short over each period: positive when
        short

        sellers added to their bet, negative when they bought shares back. A
        period with no

        value is left out.
    ComparedWithPastYear:
      properties:
        percent_of_free_float:
          $ref: '#/components/schemas/PastYearFigures'
          description: Shares sold short as a percentage of the shares that trade freely.
        days_to_cover:
          anyOf:
            - $ref: '#/components/schemas/PastYearFigures'
            - type: 'null'
          description: >-
            Shares sold short divided by the average daily volume over three
            months.
        cost_to_borrow:
          anyOf:
            - $ref: '#/components/schemas/PastYearFigures'
            - type: 'null'
          description: >-
            Yearly fee for borrowing the shares, in percent, averaged over all
            open loans.
        short_score:
          anyOf:
            - $ref: '#/components/schemas/PastYearFigures'
            - type: 'null'
          description: >-
            The ranking of short-selling pressure across all covered stocks,
            from 0 to 100.
      type: object
      required:
        - percent_of_free_float
      title: ComparedWithPastYear
      description: >-
        Each figure against its own past year. A figure with no data is left
        out.
    ShortInterestListingWithIsin:
      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
        isin:
          anyOf:
            - type: string
            - type: 'null'
          title: Isin
          description: >-
            The listing's International Securities Identification Number. Left
            out when the data provider does not know the listing.
          examples:
            - LU1778762911
      type: object
      required:
        - mic
        - ticker
      title: ShortInterestListingWithIsin
      description: The listing a company's short interest is measured on, with its ISIN.
    PastYearFigures:
      properties:
        current:
          type: number
          title: Current
          description: The figure on the latest day with data.
        three_months_ago:
          anyOf:
            - type: number
            - type: 'null'
          title: Three Months Ago
          description: The figure 63 trading days earlier. Absent with less history.
        one_year_ago:
          anyOf:
            - type: number
            - type: 'null'
          title: One Year Ago
          description: The figure 252 trading days earlier. Absent with less history.
        one_year_low:
          type: number
          title: One Year Low
          description: The lowest value from the one-year-ago day to today, both included.
        one_year_high:
          type: number
          title: One Year High
          description: The highest value from the one-year-ago day to today, both included.
      type: object
      required:
        - current
        - one_year_low
        - one_year_high
      title: PastYearFigures
      description: >-
        One figure today, three months and a year ago, and its range over the
        past year.
  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.