openapi: 3.2.0
info:
  title: Bigdata Structured Data Market 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
paths:
  /v1/price/daily/query:
    post:
      tags:
      - Market Data
      summary: Daily Prices
      description: 'Returns daily historical price and volume data for a given symbol. Supports

        stocks, ETFs, indexes, cryptocurrencies, commodities (continuous futures) and forex pairs. Each

        data point includes date, open, high, low, close, volume, change, change percentage,

        and volume-weighted average price (VWAP). Ideal for tracking daily market performance

        and conducting technical analysis over extended periods.'
      operationId: query_daily_prices_v1_price_daily_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DailyPricesQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DailyPricesResponse'
  /v1/price/intraday/query:
    post:
      tags:
      - Market Data
      summary: Intraday Prices
      description: Returns intraday historical price and volume data for a given symbol at specified intervals (e.g. 1min, 5min, 15min, 30min, 1hour). Supports stocks, ETFs, commodities (continuous futures), indexes, cryptocurrencies, and forex pairs. Each data point includes timestamp, open, high, low, close, and volume.
      operationId: query_intraday_prices_v1_price_intraday_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntradayPricesQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntradayPricesResponse'
  /v1/price/aftermarket/query:
    post:
      tags:
      - Market Data
      summary: Aftermarket Prices
      description: Returns the latest extended-hours (aftermarket) trade and quote for one or more companies. Each record includes the last aftermarket trade (price, size, timestamp) and quote (best bid/ask price and size, cumulative volume, timestamp).
      operationId: query_aftermarket_v1_price_aftermarket_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AftermarketQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AftermarketResponse'
  /v1/dividends/query:
    post:
      tags:
      - Market Data
      summary: Dividends
      description: Returns historical and upcoming dividend data for companies. Supports stocks and ETFs. Each dividend record includes ex-dividend date, record date, payment date, declaration date, dividend amount, adjusted dividend, yield, and frequency.
      operationId: query_dividends_v1_dividends_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DividendsQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DividendsResponse'
  /v1/price/changes/query:
    post:
      tags:
      - Market Data
      summary: Price Changes
      description: This endpoint track price fluctuations in real-time with the Price Changes API. Monitor percentage changes over various time periods, including daily (1D), monthly (1M), yearly (1Y) and long-term (max).
      operationId: query_price_changes_v1_price_changes_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PriceChangesQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPriceChangesResponse'
  /v1/quote/query:
    post:
      tags:
      - Market Data
      summary: Quote
      description: This endpoint provides real-time asset quotes with the Quote API. Access up-to-the-minute prices, price changes, and trading volume for individual assets, ensuring you stay on top of market movements. Assets covered include stocks, cryptocurrencies, commodities, and ETFs.
      operationId: query_company_quote_v1_quote_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyQuoteQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCompanyQuoteResponse'
  /v1/entity-sentiment/:
    post:
      tags:
      - Market Data
      summary: Entity Sentiment
      description: Returns a time series of daily sentiment metrics for a single entity over a specified date range. Sentiment is a quantified signal derived from unstructured text using rule-based and machine-learning methods, indicating likely positive or negative market impact. The response includes daily_sentiment (mean sentiment), sentiment_pressure (abnormal sentiment intensity), and abnormal_media_attention (abnormal media volume).
      operationId: query_entity_sentiment_v1_entity_sentiment__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TimeSeriesSentimentQuery'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeSeriesSentimentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
components:
  schemas:
    QueryTimestamp:
      properties:
        start:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start
          description: The start datetime of the time range for retrieving events. Only events occurring on or after this datetime will be included. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-02'
        end:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End
          description: The end datetime of the time range for retrieving events. Only events occurring on or before this datetime will be included. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-03'.
      type: object
      title: QueryTimestamp
    Identifier:
      properties:
        type:
          $ref: '#/components/schemas/IdentifierType'
          description: The identifier namespace. Currently only `rp_entity_id` is supported.
          default: rp_entity_id
          examples:
          - rp_entity_id
        value:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          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: Identifier
    DailyPricesResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/DailyPricesResults'
          type: array
          title: Results
          description: The main data result
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/ErrorDetail'
            type: array
          - type: 'null'
          title: Errors
        metadata:
          anyOf:
          - $ref: '#/components/schemas/Metadata'
          - type: 'null'
        sources:
          items:
            $ref: '#/components/schemas/Source'
          type: array
          title: Sources
          description: The content catalog 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. Present only for API keys billed in tokens.
      type: object
      required:
      - results
      title: DailyPricesResponse
      description: Company Daily Prices response model.
    DividendsResults:
      properties:
        rp_entity_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Rp Entity Id
          description: RP Entity identifier
          examples:
          - D8442A
        target_identifier_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Identifier Id
          description: The external identifier ID, such as a symbol
          examples:
          - AAPL
        fields:
          items:
            type: string
          type: array
          title: Fields
          description: Column names for the data values
          examples:
          - - DATE
            - DIVIDEND
            - ADJ_DIVIDEND
            - RECORD_DATE
            - PAYMENT_DATE
            - DECLARATION_DATE
            - YIELD
            - FREQUENCY
        values:
          items:
            items:
              anyOf:
              - type: string
              - type: number
              - type: 'null'
            type: array
          type: array
          title: Values
          description: Dividend records. Each array contains [date, dividend, adjDividend, recordDate, paymentDate, declarationDate, yield, frequency]
          examples:
          - - - '2023-08-11'
              - 0.24
              - 0.24
              - '2023-08-14'
              - '2023-08-17'
              - '2023-08-03'
              - null
              - Quarterly
            - - '2023-11-10'
              - 0.24
              - 0.24
              - '2023-11-13'
              - '2023-11-16'
              - '2023-11-02'
              - null
              - Quarterly
      type: object
      required:
      - rp_entity_id
      - target_identifier_id
      - fields
      - values
      title: DividendsResults
    IntradayPricesResponse:
      properties:
        results:
          $ref: '#/components/schemas/IntradayPricesResults'
          description: The main data result
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/ErrorDetail'
            type: array
          - type: 'null'
          title: Errors
        metadata:
          anyOf:
          - $ref: '#/components/schemas/Metadata'
          - type: 'null'
        sources:
          items:
            $ref: '#/components/schemas/Source'
          type: array
          title: Sources
          description: The content catalog 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. Present only for API keys billed in tokens.
      type: object
      required:
      - results
      title: IntradayPricesResponse
      description: Company Intraday Prices response model.
    AftermarketQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/Identifier'
          description: Object specifying which identifier you are using to request the latest extended-hours (aftermarket) trade and quote. You must supply one type and its corresponding value, or a list of values.
          examples:
          - type: rp_entity_id
            value: 4A6F00
      type: object
      required:
      - identifier
      title: AftermarketQuery
    DividendsResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/DividendsResults'
          type: array
          description: The main data result
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/ErrorDetail'
            type: array
          - type: 'null'
          title: Errors
        metadata:
          anyOf:
          - $ref: '#/components/schemas/Metadata'
          - type: 'null'
        sources:
          items:
            $ref: '#/components/schemas/Source'
          type: array
          title: Sources
          description: The content catalog 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. Present only for API keys billed in tokens.
      type: object
      required:
      - results
      title: DividendsResponse
      description: Company Dividends response model.
    AftermarketRecord:
      properties:
        rp_entity_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Rp Entity Id
          description: RavenPack internal entity identifier.
          examples:
          - 4A6F00
          - D8442A
        target_identifier_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Identifier Id
          description: The target identifier provided in the request, e.g., stock symbol.
          examples:
          - GOOGL
          - AAPL
        trade:
          anyOf:
          - $ref: '#/components/schemas/AftermarketTrade'
          - type: 'null'
          description: The latest extended-hours trade.
        quote:
          anyOf:
          - $ref: '#/components/schemas/AftermarketQuote'
          - type: 'null'
          description: The latest extended-hours quote.
      type: object
      required:
      - rp_entity_id
      - target_identifier_id
      title: AftermarketRecord
      description: Latest extended-hours trade and quote for a single entity.
    ErrorDetail:
      properties:
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
      type: object
      title: ErrorDetail
    TimeSeriesSentimentResponse:
      properties:
        results:
          $ref: '#/components/schemas/TimeSeriesSentimentResults'
          description: Sentiment time series results
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Errors
          description: List of errors encountered while fetching data.
        metadata:
          $ref: '#/components/schemas/Metadata'
          description: Request metadata including request ID and timestamp.
        sources:
          items:
            $ref: '#/components/schemas/Source'
          type: array
          title: Sources
          description: The content catalog 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. Present only for API keys billed in tokens.
      type: object
      required:
      - results
      - metadata
      title: TimeSeriesSentimentResponse
      description: Public API response for time series sentiment query.
    DailyPricesValue:
      prefixItems:
      - type: string
        format: date
      - type: number
      - type: number
      - type: number
      - type: number
      - type: integer
      - type: number
      - type: number
      - type: number
      - anyOf:
        - type: string
        - type: 'null'
      type: array
      maxItems: 10
      minItems: 10
      title: DailyPricesValue
      description: Represents one row of values as a tuple (or list).
    CompanyQuote:
      properties:
        rp_entity_id:
          type: string
          title: Rp Entity Id
          description: RavenPack internal entity identifier.
          examples:
          - 4A6F00
        target_identifier_id:
          type: string
          title: Target Identifier Id
          description: The target identifier provided in the request, e.g., stock symbol.
          examples:
          - GOOGL
        name:
          type: string
          title: Name
          description: The name of the company.
          examples:
          - Alphabet Inc.
        price:
          anyOf:
          - type: number
          - type: 'null'
          title: Price
          description: The current price of the company.
          examples:
          - 245.79
        change_percentage:
          anyOf:
          - type: number
          - type: 'null'
          title: Change Percentage
          description: The percentage change in the price of the company.
          examples:
          - -0.546
        change:
          anyOf:
          - type: number
          - type: 'null'
          title: Change
          description: The change in the price of the company.
          examples:
          - -1.35
        volume:
          anyOf:
          - type: integer
          - type: 'null'
          title: Volume
          description: The volume of the company.
          examples:
          - 30515935
        day_low:
          anyOf:
          - type: number
          - type: 'null'
          title: Day Low
          description: The low price of the company.
          examples:
          - 240.74
        day_high:
          anyOf:
          - type: number
          - type: 'null'
          title: Day High
          description: The high price of the company.
          examples:
          - 246.49
        year_high:
          anyOf:
          - type: number
          - type: 'null'
          title: Year High
          description: The highest price of the company in the last year.
          examples:
          - 256
        year_low:
          anyOf:
          - type: number
          - type: 'null'
          title: Year Low
          description: The lowest price of the company in the last year.
          examples:
          - 140.53
        market_cap:
          anyOf:
          - type: number
          - type: 'null'
          title: Market Cap
          description: The market cap of the company.
          examples:
          - 2972724892681
        price_avg_50:
          anyOf:
          - type: number
          - type: 'null'
          title: Price Avg 50
          description: The average price of the company over the last 50 days.
          examples:
          - 214.116
        price_avg_200:
          anyOf:
          - type: number
          - type: 'null'
          title: Price Avg 200
          description: The average price of the company over the last 200 days.
          examples:
          - 184.673
        exchange:
          anyOf:
          - type: string
          - type: 'null'
          title: Exchange
          description: The exchange of the company.
          examples:
          - NASDAQ
        open:
          anyOf:
          - type: number
          - type: 'null'
          title: Open
          description: The opening price of the company.
          examples:
          - 244.165
        previous_close:
          anyOf:
          - type: number
          - type: 'null'
          title: Previous Close
          description: The previous closing price of the company.
          examples:
          - 247.14
        timestamp:
          anyOf:
          - type: string
          - type: 'null'
          title: Timestamp
          description: The timestamp of the company quote.
          examples:
          - '2025-09-25T20:00:00'
        currency:
          anyOf:
          - type: string
          - type: 'null'
          title: Currency
          description: The currency of the asset.
          examples:
          - USD
      type: object
      required:
      - rp_entity_id
      - target_identifier_id
      - name
      - price
      - change_percentage
      - change
      - volume
      - day_low
      - day_high
      - year_high
      - year_low
      - market_cap
      - price_avg_50
      - price_avg_200
      - exchange
      - open
      - previous_close
      - timestamp
      - currency
      title: CompanyQuote
    DividendsQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/SingleIdentifier'
          description: Object specifying which identifier you are using to request the dividend data. You must supply one type and its corresponding value. Only one identifier should be provided per request.
          examples:
          - type: rp_entity_id
            value: 4A6F00
        limit:
          anyOf:
          - type: integer
            maximum: 1000
            minimum: 1
          - type: 'null'
          description: The maximum number of dividend records to return per entity. Must be between 1 and 1000.
          examples:
          - 100
      type: object
      required:
      - identifier
      title: DividendsQuery
    IntradayTimeFrame:
      type: string
      enum:
      - 1min
      - 5min
      - 15min
      - 30min
      - 1hour
      - 4hour
      title: IntradayTimeFrame
    DailyPriceIdentifier:
      properties:
        type:
          $ref: '#/components/schemas/DailyPriceIdentifierType'
          description: The identifier namespace. Use `rp_entity_id` for a company, or `currency_pair` for a currency pair such as `EURUSD`, which has no entity identifier of its own.
          examples:
          - rp_entity_id
          - currency_pair
        value:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          title: Value
          description: 'For `rp_entity_id`, 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`). For `currency_pair`, supply the six-character pair: the first three characters are the base currency and the last three the quote currency, each an ISO 4217 currency code. Example: `EURUSD`. Prices are not available for every currency pair.'
          examples:
          - 4A6F00
      type: object
      required:
      - type
      - value
      title: DailyPriceIdentifier
    TimeSeriesSentimentQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/Identifier'
          description: Object specifying which identifier you are using to request the sentiment data. You must supply one type and its corresponding value or a list of entities.
        timestamp:
          $ref: '#/components/schemas/QueryDateRange'
          description: The time range for retrieving sentiment data. The expected date format is 'YYYY-MM-DD', for example, '2025-09-02'.
      type: object
      required:
      - identifier
      - timestamp
      title: TimeSeriesSentimentQuery
      description: Query model for time series sentiment request.
      example:
        identifier:
          type: rp_entity_id
          value: 4A6F00
        timestamp:
          start: '2025-01-01'
          end: '2025-01-20'
    QueryDateRange:
      properties:
        start:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Start
          description: The start date of the time range for retrieving daily prices. Only prices occurring on or after this date will be included. The expected date format is 'YYYY-MM-DD', for example, '2025-09-02'
          examples:
          - '2025-01-01'
        end:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: End
          description: The end date of the time range for retrieving daily prices. Only prices occurring on or before this date will be included. The expected date format is 'YYYY-MM-DD', for example, '2025-09-03'.
          examples:
          - '2025-01-20'
      type: object
      title: QueryDateRange
    PriceChanges:
      properties:
        rp_entity_id:
          type: string
          title: Rp Entity Id
          description: RavenPack internal entity identifier.
          examples:
          - 4A6F00
        target_identifier_id:
          type: string
          title: Target Identifier Id
          description: The target identifier provided in the request, e.g., stock symbol.
          examples:
          - GOOGL
        1D:
          anyOf:
          - type: number
          - type: 'null'
          title: 1D
          description: The price change in the last 1 day.
          examples:
          - -0.546
        5D:
          anyOf:
          - type: number
          - type: 'null'
          title: 5D
          description: The price change in the last 5 days.
          examples:
          - -2.946
        1M:
          anyOf:
          - type: number
          - type: 'null'
          title: 1M
          description: The price change in the last 1 month.
          examples:
          - 18.659
        3M:
          anyOf:
          - type: number
          - type: 'null'
          title: 3M
          description: The price change in the last 3 months.
          examples:
          - 41.633
        6M:
          anyOf:
          - type: number
          - type: 'null'
          title: 6M
          description: The price change in the last 6 months.
          examples:
          - 48.909
        ytd:
          anyOf:
          - type: number
          - type: 'null'
          title: Ytd
          description: The price change in the last year to date.
          examples:
          - 29.752
        1Y:
          anyOf:
          - type: number
          - type: 'null'
          title: 1Y
          description: The price change in the last 1 year.
          examples:
          - 51.042
        3Y:
          anyOf:
          - type: number
          - type: 'null'
          title: 3Y
          description: The price change in the last 3 years.
          examples:
          - 150.372
        5Y:
          anyOf:
          - type: number
          - type: 'null'
          title: 5Y
          description: The price change in the last 5 years.
          examples:
          - 237.022
        10Y:
          anyOf:
          - type: number
          - type: 'null'
          title: 10Y
          description: The price change in the last 10 years.
          examples:
          - 687.536
        max:
          anyOf:
          - type: number
          - type: 'null'
          title: Max
          description: The price change in the last max years.
          examples:
          - 9692.43
      type: object
      required:
      - rp_entity_id
      - target_identifier_id
      - 1D
      - 5D
      - 1M
      - 3M
      - 6M
      - ytd
      - 1Y
      - 3Y
      - 5Y
      - 10Y
      - max
      title: PriceChanges
    SentimentDataPoint:
      properties:
        date:
          type: string
          title: Date
          description: Date in YYYY-MM-DD format
          examples:
          - '2025-10-20'
        daily_sentiment:
          anyOf:
          - type: number
          - type: 'null'
          title: Daily Sentiment
          description: 'The daily mean event sentiment represents the weighted average sentiment of all events detected on the same day for a given entity. Each event''s sentiment is weighted by its relevance and novelty using a quadratic function. The sentiment score ranges from -1 (negative sentiment) to 1 (positive sentiment). This sentiment is enhanced by considering the entity sentiment from documents without events. Sentiment from subsidiaries is also added at parent level. Use-case: Captures the overall tone of news and events for a company on a given day, ranging from very negative to very positive.'
          examples:
          - 0.017404
        sentiment_pressure:
          anyOf:
          - type: number
          - type: 'null'
          title: Sentiment Pressure
          description: 'The Z-score of the 90-days moving average of the daily sentiment normalized to [-1,1] using a sigmoid function. Absolute values over 0.9 can be considered abnormal, which approximately matches 3 standard deviations. A year is considered for z-standardization. Use-case: Measures how sentiment over the last 90 days compares to recent history, highlighting unusually strong positive or negative sentiment trends.'
          examples:
          - 0.217784
        abnormal_media_attention:
          anyOf:
          - type: number
          - type: 'null'
          title: Abnormal Media Attention
          description: 'The Z-score of the daily volume of media events for a company normalized to [-1,1] using a sigmoid function, indicating abnormal media attention. Absolute values over 0.9 can be considered abnormal, which approximately matches 3 standard deviations. Use-case: Indicates whether a company is receiving more or less media attention than usual, based on recent trends.'
          examples:
          - -0.833533
      type: object
      required:
      - date
      title: SentimentDataPoint
      description: Individual sentiment data for a specific date.
    PublicPriceChangesResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/PriceChanges'
          type: array
          title: Results
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/ErrorDetail'
            type: array
          - type: 'null'
          title: Errors
        metadata:
          anyOf:
          - $ref: '#/components/schemas/Metadata'
          - type: 'null'
        sources:
          items:
            $ref: '#/components/schemas/Source'
          type: array
          title: Sources
          description: The content catalog 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. Present only for API keys billed in tokens.
      type: object
      required:
      - results
      title: PublicPriceChangesResponse
    DailyPricesQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/DailyPriceIdentifier'
          description: Object specifying which identifier you are using to request the daily price. You must supply one type and its corresponding value. Only one identifier should be provided per request.
          examples:
          - type: rp_entity_id
            value: 4A6F00
        date_range:
          anyOf:
          - $ref: '#/components/schemas/QueryDateRange'
          - type: 'null'
          description: The date range for retrieving daily prices. All dates must be provided in the local time zone of the security exchange, and all results are returned in that same local exchange time. The expected date format is 'YYYY-MM-DD', for example, '2025-09-02'.
          examples:
          - end: '2023-09-05'
            start: '2023-09-01'
      type: object
      required:
      - identifier
      - date_range
      title: DailyPricesQuery
    DailyPricesResults:
      properties:
        rp_entity_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Rp Entity Id
          description: RavenPack internal entity identifier.
          examples:
          - 4A6F00
          - D8442A
        target_identifier_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Identifier Id
          description: The target identifier provided in the request, e.g., stock symbol.
          examples:
          - AAPL
          - MSFT
        fields:
          items:
            type: string
          type: array
          title: Fields
          description: Column names for the data values
          examples:
          - - DATE
            - OPEN
            - LOW
            - HIGH
            - CLOSE
            - VOLUME
            - CHANGE
            - CHANGE_PERCENT
            - VWAP
            - CURRENCY
        values:
          items:
            $ref: '#/components/schemas/DailyPricesValue'
          type: array
          title: Values
          description: Daily Prices records, ordered from the most recent date to the oldest.
          examples:
          - - '2025-09-22'
            - 254.43
            - 250.3
            - 255.78
            - 252.53
            - 32255300
            - -1.9
            - -0.74677
            - 253.26
            - USD
      type: object
      required:
      - rp_entity_id
      - target_identifier_id
      - fields
      - values
      title: DailyPricesResults
      description: Prices for an entity id.
    DailyPriceIdentifierType:
      type: string
      enum:
      - rp_entity_id
      - currency_pair
      title: DailyPriceIdentifierType
    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
    IntradayPricesQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/SingleIdentifier'
          description: Object specifying which identifier you are using to request the intraday price. You must supply one type and its corresponding value. Only one identifier should be provided per request.
          examples:
          - type: rp_entity_id
            value: 4A6F00
        timestamp:
          anyOf:
          - $ref: '#/components/schemas/QueryTimestamp'
          - type: 'null'
          description: The time range for retrieving intraday prices. All timestamps must be provided in the local time zone of the security exchange, and all results are returned in that same local exchange time. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-02'.
          examples:
          - start: '2023-09-01'
            end: '2023-09-02'
        interval:
          $ref: '#/components/schemas/IntradayTimeFrame'
          description: The time interval for each intraday price data point. For example, '1min', '5min', '15min', '30min', '1hour', '4hour'.
          examples:
          - 15min
          - 30min
      type: object
      required:
      - identifier
      - timestamp
      - interval
      title: IntradayPricesQuery
    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
    IdentifierType:
      type: string
      enum:
      - rp_entity_id
      title: IdentifierType
      default: rp_entity_id
    IntradayPricesValue:
      prefixItems:
      - type: string
        format: date-time
      - type: number
      - type: number
      - type: number
      - type: number
      - type: integer
      - type: string
      type: array
      maxItems: 7
      minItems: 7
      title: IntradayPricesValue
      description: Represents one row of values as a tuple (or list).
    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.
    CompanyQuoteQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/Identifier'
          description: Object specifying which identifier you are using to request the quote. You must supply one type and its corresponding value.
      type: object
      required:
      - identifier
      title: CompanyQuoteQuery
    IntradayPricesResults:
      properties:
        rp_entity_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Rp Entity Id
          description: RP Entity identifier
          examples:
          - 4A6F00
        target_identifier_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Identifier Id
          description: The external identifier ID, such as a symbol
          examples:
          - GOOGL
        fields:
          items:
            type: string
          type: array
          title: Fields
          description: Column names for the data values
          examples:
          - - TIMESTAMP
            - OPEN
            - LOW
            - HIGH
            - CLOSE
            - VOLUME
            - CURRENCY
        values:
          items:
            $ref: '#/components/schemas/IntradayPricesValue'
          type: array
          title: Values
          description: Intraday Prices records
          examples:
          - - '2025-09-15T09:30:00'
            - 244.77
            - 244.66
            - 252.4
            - 249.52
            - 41229669
            - USD
      type: object
      required:
      - rp_entity_id
      - target_identifier_id
      - fields
      - values
      title: IntradayPricesResults
      description: Alternative result model with strongly typed records.
    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
    TimeSeriesSentimentResults:
      properties:
        name:
          type: string
          title: Name
          description: Company name
          examples:
          - Alphabet Inc.
        id:
          type: string
          title: Id
          description: RP entity identifier
          examples:
          - 4A6F00
        values:
          items:
            $ref: '#/components/schemas/SentimentDataPoint'
          type: array
          title: Values
          description: List of sentiment data points
          examples:
          - - date: '2025-10-20'
              daily_sentiment: 0.017404
              sentiment_pressure: 0.217784
              abnormal_media_attention: -0.833533
            - date: '2025-10-21'
              daily_sentiment: 0.033251
              sentiment_pressure: 0.208085
              abnormal_media_attention: -0.835593
      type: object
      required:
      - name
      - id
      - values
      title: TimeSeriesSentimentResults
      description: Results container for time series sentiment data.
    IdentifierTypeEnum:
      type: string
      enum:
      - rp_entity_id
      title: IdentifierTypeEnum
    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
    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.'
    AftermarketQuote:
      properties:
        bid_price:
          anyOf:
          - type: number
          - type: 'null'
          title: Bid Price
          description: The best extended-hours bid price.
          examples:
          - 245.5
        bid_size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Bid Size
          description: The size available at the best bid.
          examples:
          - 200
        ask_price:
          anyOf:
          - type: number
          - type: 'null'
          title: Ask Price
          description: The best extended-hours ask price.
          examples:
          - 245.9
        ask_size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Ask Size
          description: The size available at the best ask.
          examples:
          - 150
        volume:
          anyOf:
          - type: integer
          - type: 'null'
          title: Volume
          description: The cumulative extended-hours volume.
          examples:
          - 1250000
        timestamp:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Timestamp
          description: The time of the last extended-hours quote (UTC).
          examples:
          - '2025-09-25T23:59:00'
      type: object
      title: AftermarketQuote
      description: Latest extended-hours (aftermarket) quote.
    Metadata:
      properties:
        request_id:
          type: string
          title: Request Id
        timestamp:
          type: string
          title: Timestamp
      type: object
      required:
      - request_id
      title: Metadata
    PriceChangesQuery:
      properties:
        identifier:
          $ref: '#/components/schemas/Identifier'
          description: Object specifying which identifier you are using to request the price changes. You must supply one type and its corresponding value.
      type: object
      required:
      - identifier
      title: PriceChangesQuery
    AftermarketResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/AftermarketRecord'
          type: array
          title: Results
          description: The main data result
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/ErrorDetail'
            type: array
          - type: 'null'
          title: Errors
        metadata:
          anyOf:
          - $ref: '#/components/schemas/Metadata'
          - type: 'null'
        sources:
          items:
            $ref: '#/components/schemas/Source'
          type: array
          title: Sources
          description: The content catalog 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. Present only for API keys billed in tokens.
      type: object
      required:
      - results
      title: AftermarketResponse
      description: Company aftermarket trades & quotes response model.
    PublicCompanyQuoteResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/CompanyQuote'
          type: array
          title: Results
        errors:
          anyOf:
          - items:
              $ref: '#/components/schemas/ErrorDetail'
            type: array
          - type: 'null'
          title: Errors
        metadata:
          anyOf:
          - $ref: '#/components/schemas/Metadata'
          - type: 'null'
        sources:
          items:
            $ref: '#/components/schemas/Source'
          type: array
          title: Sources
          description: The content catalog 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. Present only for API keys billed in tokens.
      type: object
      required:
      - results
      title: PublicCompanyQuoteResponse
    AftermarketTrade:
      properties:
        price:
          anyOf:
          - type: number
          - type: 'null'
          title: Price
          description: The last extended-hours trade price.
          examples:
          - 245.79
        trade_size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Trade Size
          description: The size (number of shares) of the last extended-hours trade.
          examples:
          - 100
        timestamp:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Timestamp
          description: The time of the last extended-hours trade (UTC).
          examples:
          - '2025-09-25T23:59:00'
      type: object
      title: AftermarketTrade
      description: Latest extended-hours (aftermarket) trade.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY