roic-ai Market Data API

openapi: 3.2.0
info:
  title: ROIC Market Data API
  description: The ROIC API reference for v3 (`/v3.0.0`) and legacy v2 (`/v2`). In v3, Bearer authentication is recommended because it keeps credentials out of URLs. For browser testing, you may instead pass your key as the `apikey` query parameter. Use exactly one authentication method per request, never both. v2 takes the key only as the `apikey` query parameter.
  version: 3.0.0
servers:
- url: https://api.roic.ai
tags:
- name: Market Data
  description: Historical and current market data resources.
paths:
  /v3.0.0/stock-splits:
    get:
      operationId: listStockSplits
      summary: List stock splits
      description: Returns a page of per-ticker stock-split events across all tickers, or one ticker via the identifier filter.
      tags:
      - Market Data
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      parameters:
      - name: apikey
        in: query
        required: false
        schema:
          description: Browser-friendly alternative to Bearer authentication. Use either this parameter or the Authorization header, never both.
          type: string
      - name: identifier
        in: query
        required: false
        schema:
          minLength: 1
          maxLength: 128
          title: identifier
          description: Restrict results to a single ticker. Accepts an exchange and symbol separated by a colon (e.g. `NASDAQ:AAPL`), a ticker ID, or a FIGI. Stock splits are per ticker, so results are the split events for that exact listing. Omit to list splits across all tickers.
          examples:
          - NASDAQ:AAPL
          - tkr_cO46h8pgSu9Qqy
          - BBG000B9XRY4
          type: string
      - name: date
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return splits executed on exactly this date.
          type: string
      - name: date.gte
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return splits whose execution date is on or after this date.
          type: string
      - name: date.gt
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return splits whose execution date is strictly after this date.
          type: string
      - name: date.lte
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return splits whose execution date is on or before this date.
          type: string
      - name: date.lt
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return splits whose execution date is strictly before this date.
          type: string
      - name: order
        in: query
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: limit
        in: query
        required: false
        schema:
          minimum: 1
          maximum: 500
          multipleOf: 1
          default: 100
          title: limit
          description: Maximum number of resources to return. Defaults to 100.
          anyOf:
          - format: numeric
            default: 0
            type: string
          - minimum: 1
            maximum: 500
            multipleOf: 1
            default: 100
            title: limit
            description: Maximum number of resources to return. Defaults to 100.
            type: number
      - name: page
        in: query
        required: false
        schema:
          maxLength: 4096
          description: Opaque page token from a previous response. Prefer following the returned page URLs directly.
          type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.StockSplitList'
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '402':
          description: Response for status 402
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '429':
          description: Response for status 429
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '503':
          description: Response for status 503
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
      x-fern-sdk-group-name: stockSplits
      x-fern-sdk-method-name: list
  /v3.0.0/stock-prices/latest:
    get:
      operationId: listLatestStockPrices
      summary: List latest stock prices
      description: Returns a page with one row per ticker carrying its latest available daily OHLCV quote from the last 10 days. Tickers without a price in that window (halted, delisted, or unpriced listings) appear with null price fields. Requires an Individual or higher plan.
      tags:
      - Market Data
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      parameters:
      - name: apikey
        in: query
        required: false
        schema:
          description: Browser-friendly alternative to Bearer authentication. Use either this parameter or the Authorization header, never both.
          type: string
      - name: exchange
        in: query
        required: false
        schema:
          minLength: 1
          maxLength: 32
          title: exchange
          description: Filter to tickers listed on one exchange code, e.g. `NASDAQ`.
          type: string
      - name: order
        in: query
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: limit
        in: query
        required: false
        schema:
          minimum: 1
          maximum: 2000
          multipleOf: 1
          default: 500
          title: limit
          description: Maximum number of resources to return. Defaults to 500.
          anyOf:
          - format: numeric
            default: 0
            type: string
          - minimum: 1
            maximum: 2000
            multipleOf: 1
            default: 500
            title: limit
            description: Maximum number of resources to return. Defaults to 500.
            type: number
      - name: page
        in: query
        required: false
        schema:
          maxLength: 4096
          description: Opaque page token from a previous response. Prefer following the returned page URLs directly.
          type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.LatestStockPriceList'
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '402':
          description: Response for status 402
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '429':
          description: Response for status 429
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '503':
          description: Response for status 503
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
      x-fern-sdk-group-name: stockPrices.latest
      x-fern-sdk-method-name: list
  /v3.0.0/stock-prices/{identifier}:
    get:
      operationId: listHistoricalStockPrices
      summary: List historical stock prices
      description: Returns a page of historical daily prices for a ticker, symbol, or other supported security identifier.
      tags:
      - Market Data
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          minLength: 1
          maxLength: 128
          description: A ticker ID, an exchange and symbol separated by a colon (e.g. `NASDAQ:AAPL`), or a FIGI.
          examples:
          - NASDAQ:AAPL
          - tkr_cO46h8pgSu9Qqy
          - BBG000B9XRY4
          type: string
      - name: apikey
        in: query
        required: false
        schema:
          description: Browser-friendly alternative to Bearer authentication. Use either this parameter or the Authorization header, never both.
          type: string
      - name: date
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return prices from exactly this date.
          type: string
      - name: date.gte
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return prices whose date is on or after this date.
          type: string
      - name: date.gt
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return prices whose date is strictly after this date.
          type: string
      - name: date.lte
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return prices whose date is on or before this date.
          type: string
      - name: date.lt
        in: query
        required: false
        schema:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: Return prices whose date is strictly before this date.
          type: string
      - name: adjustment
        in: query
        required: false
        schema:
          type: string
          enum:
          - none
          - splits
          - total_return
      - name: adjusted
        in: query
        required: false
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: order
        in: query
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: limit
        in: query
        required: false
        schema:
          minimum: 1
          maximum: 1000
          multipleOf: 1
          default: 250
          title: limit
          description: Maximum number of resources to return. Defaults to 250.
          anyOf:
          - format: numeric
            default: 0
            type: string
          - minimum: 1
            maximum: 1000
            multipleOf: 1
            default: 250
            title: limit
            description: Maximum number of resources to return. Defaults to 250.
            type: number
      - name: page
        in: query
        required: false
        schema:
          maxLength: 4096
          description: Opaque page token from a previous response. Prefer following the returned page URLs directly.
          type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.HistoricalPriceList'
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '402':
          description: Response for status 402
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '429':
          description: Response for status 429
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '503':
          description: Response for status 503
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
      x-fern-sdk-group-name: stockPrices
      x-fern-sdk-method-name: list
  /v3.0.0/stock-prices/latest/{identifier}:
    get:
      operationId: retrieveLatestStockPrice
      summary: Retrieve the latest stock price
      description: Returns the latest available daily price for a ticker, symbol, or other supported security identifier.
      tags:
      - Market Data
      security:
      - bearerAuth: []
      - apiKeyAuth: []
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          minLength: 1
          maxLength: 128
          description: A ticker ID, an exchange and symbol separated by a colon (e.g. `NASDAQ:AAPL`), or a FIGI.
          examples:
          - NASDAQ:AAPL
          - tkr_cO46h8pgSu9Qqy
          - BBG000B9XRY4
          type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.HistoricalPrice'
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '429':
          description: Response for status 429
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
        '503':
          description: Response for status 503
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3.Error'
      x-fern-sdk-group-name: stockPrices.latest
      x-fern-sdk-method-name: retrieve
components:
  schemas:
    v3.StockSplitList:
      additionalProperties: false
      type: object
      properties:
        data:
          type: array
          items:
            additionalProperties: false
            type: object
            properties:
              id:
                type: string
              object:
                const: v3.market_data.stock_split
                type: string
              symbol:
                type: string
              exchange:
                type: string
              mic:
                anyOf:
                - type: string
                - type: 'null'
              execution_date:
                pattern: ^\d{4}-\d{2}-\d{2}$
                minLength: 10
                maxLength: 10
                description: A calendar date in YYYY-MM-DD format.
                type: string
              factor:
                exclusiveMinimum: 0
                type: number
              split_from:
                anyOf:
                - minimum: 1
                  anyOf:
                  - format: integer
                    default: 0
                    type: string
                  - minimum: 1
                    type: integer
                - type: 'null'
              split_to:
                anyOf:
                - minimum: 1
                  anyOf:
                  - format: integer
                    default: 0
                    type: string
                  - minimum: 1
                    type: integer
                - type: 'null'
              is_reverse:
                type: boolean
              pre_split_shares:
                anyOf:
                - type: number
                - type: 'null'
              post_split_shares:
                anyOf:
                - type: number
                - type: 'null'
              pre_split_price:
                anyOf:
                - type: number
                - type: 'null'
              post_split_price:
                anyOf:
                - type: number
                - type: 'null'
              currency:
                anyOf:
                - type: string
                - type: 'null'
              updated_at:
                format: date-time
                type: string
            required:
            - id
            - object
            - symbol
            - exchange
            - mic
            - execution_date
            - factor
            - split_from
            - split_to
            - is_reverse
            - pre_split_shares
            - post_split_shares
            - pre_split_price
            - post_split_price
            - currency
            - updated_at
            $id: '#/components/schemas/v3.StockSplit'
        next_page_url:
          anyOf:
          - type: string
          - type: 'null'
        previous_page_url:
          anyOf:
          - type: string
          - type: 'null'
      required:
      - data
      - next_page_url
      - previous_page_url
      $id: '#/components/schemas/v3.StockSplitList'
    v3.Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - invalid_request_error
              - authentication_error
              - payment_required_error
              - conflict_error
              - rate_limit_error
              - api_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
            doc_url:
              type: string
            request_id:
              type: string
          required:
          - type
          - code
          - message
          - request_id
      required:
      - error
      $id: '#/components/schemas/v3.Error'
    v3.HistoricalPrice:
      additionalProperties: false
      type: object
      properties:
        symbol:
          description: The qualified ticker symbol this quote belongs to, e.g. `NASDAQ:AAPL`.
          type: string
        date:
          pattern: ^\d{4}-\d{2}-\d{2}$
          minLength: 10
          maxLength: 10
          description: A calendar date in YYYY-MM-DD format.
          type: string
        open:
          anyOf:
          - type: number
          - type: 'null'
        high:
          anyOf:
          - type: number
          - type: 'null'
        low:
          anyOf:
          - type: number
          - type: 'null'
        close:
          type: number
        volume:
          anyOf:
          - type: number
          - type: 'null'
        currency:
          description: ISO 4217 code this quote is priced in, e.g. `USD`.
          anyOf:
          - type: string
          - type: 'null'
      required:
      - symbol
      - date
      - open
      - high
      - low
      - close
      - volume
      - currency
      $id: '#/components/schemas/v3.HistoricalPrice'
    v3.HistoricalPriceList:
      additionalProperties: false
      type: object
      properties:
        data:
          description: The historical prices in this page.
          type: array
          items:
            additionalProperties: false
            type: object
            properties:
              date:
                pattern: ^\d{4}-\d{2}-\d{2}$
                minLength: 10
                maxLength: 10
                description: A calendar date in YYYY-MM-DD format.
                type: string
              open:
                anyOf:
                - type: number
                - type: 'null'
              high:
                anyOf:
                - type: number
                - type: 'null'
              low:
                anyOf:
                - type: number
                - type: 'null'
              close:
                type: number
              volume:
                anyOf:
                - type: number
                - type: 'null'
            required:
            - date
            - open
            - high
            - low
            - close
            - volume
            $id: '#/components/schemas/v3.HistoricalPricePoint'
        symbol:
          description: The qualified ticker symbol every quote in `data` belongs to, e.g. `NASDAQ:AAPL`. Present even when `data` is empty.
          type: string
        currency:
          description: ISO 4217 code every quote in `data` is priced in, e.g. `USD`. A ticker is only ever quoted in one currency. Null when the page carries no priced quotes.
          anyOf:
          - type: string
          - type: 'null'
        next_page_url:
          description: URL for the next page, or null when this is the last page.
          anyOf:
          - type: string
          - type: 'null'
        previous_page_url:
          description: URL for the previous page, or null when this is the first page.
          anyOf:
          - type: string
          - type: 'null'
      required:
      - data
      - symbol
      - currency
      - next_page_url
      - previous_page_url
      $id: '#/components/schemas/v3.HistoricalPriceList'
    v3.LatestStockPriceList:
      additionalProperties: false
      type: object
      properties:
        data:
          description: The latest prices in this page, one row per ticker.
          type: array
          items:
            additionalProperties: false
            type: object
            properties:
              symbol:
                description: The qualified ticker symbol this quote belongs to, e.g. `NASDAQ:AAPL`.
                type: string
              date:
                description: Trading date of the latest available quote, or null when the ticker has no price inside the freshness window.
                anyOf:
                - pattern: ^\d{4}-\d{2}-\d{2}$
                  minLength: 10
                  maxLength: 10
                  description: A calendar date in YYYY-MM-DD format.
                  type: string
                - type: 'null'
              open:
                anyOf:
                - type: number
                - type: 'null'
              high:
                anyOf:
                - type: number
                - type: 'null'
              low:
                anyOf:
                - type: number
                - type: 'null'
              close:
                anyOf:
                - type: number
                - type: 'null'
              volume:
                anyOf:
                - type: number
                - type: 'null'
              currency:
                description: ISO 4217 code this quote is priced in, e.g. `USD`.
                anyOf:
                - type: string
                - type: 'null'
            required:
            - symbol
            - date
            - open
            - high
            - low
            - close
            - volume
            - currency
            $id: '#/components/schemas/v3.LatestStockPrice'
        next_page_url:
          description: URL for the next page, or null when this is the last page.
          anyOf:
          - type: string
          - type: 'null'
        previous_page_url:
          description: URL for the previous page, or null when this is the first page.
          anyOf:
          - type: string
          - type: 'null'
      required:
      - data
      - next_page_url
      - previous_page_url
      $id: '#/components/schemas/v3.LatestStockPriceList'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Recommended. Send your ROIC API key as a Bearer token.
    apiKeyAuth:
      type: apiKey
      in: query
      name: apikey
      description: Browser-friendly alternative. Do not combine this query parameter with the Authorization header.