InsightSentry

https://insightsentry.com/docs/v2/
Admin
InsightSentry is a platform offering a dashboard and API playground, suggesting a service for data...
Tokens:28,795
Snippets:72
Trust Score:4.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### API: Get Option List

Source: https://insightsentry.com/docs/v2/openapi

Retrieves a list of available option contracts for a given symbol.

```APIDOC
"get": {
  "summary": "List available options",
  "description": "Retrieve list of available option contracts for a given symbol",
  "parameters": [
    {
      "$ref": "#/components/parameters/SymbolCodeQueryParam"
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/OptionListResponse"
    }
  }
}
```

--------------------------------

### Stock Screener API

Source: https://insightsentry.com/docs/v2/openapi

Provides functionality to get available stock screener parameters and to screen stocks based on specified criteria. Supports flexible request bodies similar to GraphQL.

```APIDOC
/v2/screeners/stock
  get:
    summary: Get available stock screener parameters
    description: Retrieve the list of available fields and parameters for stock screening
    responses:
      200:
        $ref: "#/components/responses/ScreenerParametersResponse"
  post:
    summary: Stock Screener
    description: Retrieve stock data based on specified filter criteria
    parameters: []
    responses:
      200:
        $ref: "#/components/responses/ScreenerDataResponse"
    requestBody:
      content:
        application/json:
          schema:
            allOf:
              - $ref: "#/components/schemas/ScreenerRequest"
              - description: "Flexible request body similar to GraphQL. You can include any filter criteria beyond the fixed properties (fields, exchanges, countries, page, sortBy, sortOrder). Common examples include: market_cap_min, market_cap_max, volume_min, volume_max, price_min, price_max, etc."
          example:
            fields: ["close", "volume", "market_cap"]
            exchanges: ["NYSE", "NASDAQ"]
            countries: ["US", "CA"]
            page: 1
            sortBy: "market_cap"
            sortOrder: "desc"
```

--------------------------------

### ETF Screener API

Source: https://insightsentry.com/docs/v2/openapi

Provides functionality to get available ETF screener parameters and to screen ETFs based on specified criteria. Supports flexible request bodies similar to GraphQL.

```APIDOC
/v2/screeners/etf
  get:
    summary: Get available ETF screener parameters
    description: Retrieve the list of available fields and parameters for ETF screening
    responses:
      200:
        $ref: "#/components/responses/ScreenerParametersResponse"
  post:
    summary: ETF Screener
    description: Retrieve ETF data based on specified filter criteria
    parameters: []
    responses:
      200:
        $ref: "#/components/responses/ScreenerDataResponse"
    requestBody:
      content:
        application/json:
          schema:
            allOf:
              - $ref: "#/components/schemas/ScreenerRequest"
              - description: "Flexible request body similar to GraphQL. You can include any filter criteria beyond the fixed properties (fields, exchanges, countries, page, sortBy, sortOrder). Common examples include: asset_class, expense_ratio_min, expense_ratio_max, aum_min, aum_max, etc."
          example:
            fields: ["close", "volume"]
```

--------------------------------

### API: Get Option Chain by Strike Price

Source: https://insightsentry.com/docs/v2/openapi

Retrieves option chain data for a specific strike price. Requires a symbol code and a strike price.

```APIDOC
"get": {
  "summary": "Option chain by strike price",
  "description": "Retrieve option chain data for a specific strike price",
  "parameters": [
    {
      "$ref": "#/components/parameters/SymbolCodeQueryParam"
    },
    {
      "name": "strike",
      "in": "query",
      "required": true,
      "description": "(Required) Strike Price",
      "example": "210",
      "schema": {
        "type": "number",
        "minimum": 0
      }
    },
    {
      "$ref": "#/components/parameters/SortByParam"
    },
    {
      "$ref": "#/components/parameters/SortOrderParam"
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/OptionDataResponse"
    }
  }
}
```

--------------------------------

### Get Financial Data and Metrics

Source: https://insightsentry.com/docs/v2/openapi

Retrieves comprehensive financial data for a given symbol, including company information, valuation ratios, profitability metrics, balance sheet, cash flow, and income statement details.

```APIDOC
paths:
  /v2/symbols/{symbol}/financials:
    parameters:
      - $ref: "#/components/parameters/SymbolPathParam"
    get:
      summary: Financial data and metrics
      description: Retrieve comprehensive financial data including company info, valuation ratios, profitability metrics, balance sheet, cash flow, income statement, and more
      parameters: []
      responses:
        200:
          $ref: "#/components/responses/FinancialsResponse"
```

--------------------------------

### API: Get Earnings Calendar

Source: https://insightsentry.com/docs/v2/openapi

Retrieves earnings calendar data.

```APIDOC
"get": {
  "summary": "Earnings calendar",
  "description": "Retrieve earnings calendar data for a specified time range",
  "parameters": [
    {
      "$ref": "#/components/parameters/WeekRangeParam"
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/EarningsResponse"
    }
  }
}
```

--------------------------------

### API: Get Dividend Calendar

Source: https://insightsentry.com/docs/v2/openapi

Retrieves dividend calendar data for a specified time range.

```APIDOC
"get": {
  "summary": "Dividend calendar",
  "description": "Retrieve dividend calendar data for a specified time range",
  "parameters": [
    {
      "$ref": "#/components/parameters/WeekRangeParam"
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/DividendResponse"
    }
  }
}
```

--------------------------------

### Get Real-time OHLCV Data

Source: https://insightsentry.com/docs/v2/openapi

Retrieves real-time OHLCV (Open, High, Low, Close, Volume) data for a symbol. This endpoint is faster than the /history endpoint and supports various bar types, intervals, and adjustments.

```APIDOC
paths:
  /v2/symbols/{symbol}/series:
    parameters:
      - $ref: "#/components/parameters/SymbolPathParam"
    get:
      summary: Real-time OHLCV data
      description: Retrieve real-time OHLCV data. Faster than /history endpoint
      parameters:
        - $ref: "#/components/parameters/BarTypeParam"
        - $ref: "#/components/parameters/BarIntervalParam"
        - $ref: "#/components/parameters/ExtendedParam"
        - $ref: "#/components/parameters/DividendAdjustmentParam"
        - $ref: "#/components/parameters/BackAdjustmentParam"
        - $ref: "#/components/parameters/DataPointsParamMin"
      responses:
        200:
          $ref: "#/components/responses/HistoricalDataResponse"
```

--------------------------------

### Get Deep Historical Data

Source: https://insightsentry.com/docs/v2/openapi

Retrieves historical data for specific time periods, offering access to a deep archive. Requires specifying the bar type, interval, and a start period in YYYY-MM format (or YYYY-MM-DD for second intervals).

```APIDOC
paths:
  /v2/symbols/{symbol}/history/deep:
    parameters:
      - $ref: "#/components/parameters/SymbolPathParam"
    get:
      summary: Deep historical data
      description: Retrieve historical data for specific time periods with deep archive access
      parameters:
        - name: bar_type
          in: query
          required: true
          description: (Required) Bar type.
          example: minute
          schema:
            type: string
            enum: ["second", "minute", "hour"]
        - $ref: "#/components/parameters/BarIntervalParam"
        - name: start_ym
          in: query
          required: true
          description: Starting period in YYYY-MM format for minute/hour intervals or YYYY-MM-DD for second intervals (UTC)
          example: "2024-04"
          schema:
            type: string
            format: date
            pattern: "^\\d{4}-\\d{2}(-\\d{2})?$"
        - $ref: "#/components/parameters/ExtendedParam"
        - $ref: "#/components/parameters/DividendAdjustmentParam"
        - $ref: "#/components/parameters/BackAdjustmentParam"
      responses:
        200:
          $ref: "#/components/responses/HistoricalDataResponse"
```

--------------------------------

### InsightSentry API Information

Source: https://insightsentry.com/docs/v2/openapi

Provides metadata about the InsightSentry API, including title, version, description, contact information, license, and available servers.

```APIDOC
info:
  title: InsightSentry API
  version: 2.5.0
  description: Comprehensive financial data API providing access to global equities, indices, futures, options, cryptocurrencies, and forex markets with real-time and historical data.
  contact:
    name: InsightSentry Support
    email: support@insightsentry.com
    url: https://insightsentry.com/
  license:
    name: Terms of Service
    url: https://insightsentry.com/terms
servers:
  - url: https://api.insightsentry.com
    description: Insightsentry API Gateway
  - url: https://insightsentry.p.rapidapi.com/
    description: RapidAPI Gateway
```

--------------------------------

### Equity Screener API

Source: https://insightsentry.com/docs/v2/openapi

Provides endpoints to retrieve available equity screener parameters and to screen for equity data based on specified criteria. Supports filtering by fields, exchanges, and countries, with options for pagination and sorting.

```APIDOC
GET /v2/screeners/equity
  Summary: Get available equity screener parameters
  Description: Retrieve the list of available fields and parameters for equity screening.
  Parameters: []
  Responses:
    200:
      $ref: "#/components/responses/ScreenerParametersResponse"

POST /v2/screeners/equity
  Summary: Equity Screener
  Description: Retrieve equity data based on specified filter criteria.
  Parameters: []
  Responses:
    200:
      $ref: "#/components/responses/ScreenerDataResponse"
  RequestBody:
    content:
      application/json:
        schema:
          allOf:
            - $ref: "#/components/schemas/ScreenerRequest"
            - description: "Flexible request body similar to GraphQL. You can include any filter criteria beyond the fixed properties (fields, exchanges, countries, page, sortBy, sortOrder). Common examples include: market_cap_min, volume_min, pe_ratio_min, etc."
        example:
          fields: ["close_percent", "yield_to_maturity", "volume"]
          exchanges: ["NYSE", "NASDAQ"]
          countries: ["US", "CA"]
          page: 1
          sortBy: "nav"
          sortOrder: "desc"
```

--------------------------------

### Crypto Screener API

Source: https://insightsentry.com/docs/v2/openapi

Provides endpoints to retrieve available crypto screener parameters and to screen for cryptocurrency data based on specified criteria. Supports filtering by fields, with options for pagination and sorting.

```APIDOC
GET /v2/screeners/crypto
  Summary: Get available crypto screener parameters
  Description: Retrieve the list of available fields and parameters for crypto screening.
  Responses:
    200:
      description: Available crypto screener parameters
      content:
        application/json:
          schema:
            type: object
            properties:
              available_fields:
                type: array
                items:
                  type: string
              sortOrder:
                type: array
                items:
                  type: string

POST /v2/screeners/crypto
  Summary: Crypto Screener
  Description: Retrieve cryptocurrency data based on specified filter criteria.
  Parameters: []
  Responses:
    200:
      $ref: "#/components/responses/ScreenerDataResponse"
  RequestBody:
    content:
      application/json:
        schema:
          type: object
          description: Crypto screener request body
          properties:
            fields:
              type: array
              items:
                type: string
                pattern: "^[a-zA-Z0-9_]+$"
                example: "close"
              description: Array of field names to include in the response. You can find available fields in the Get Screener endpoint. At least one field must be specified, up to 10 fields maximum.
            page:
              type: integer
              default: 1
              description: Page number for pagination
            sortBy:
              type: string
              default: "name"
              description: Field name to sort by. It should be one of fields you specify. If not specified, it will sort by the symbol name.
            sortOrder:
              type: string
              default: "asc"
              enum: ["asc", "desc"]
              description: Sort order - ascending or descending
          required: []
```

--------------------------------

### Get WebSocket Key

Source: https://insightsentry.com/docs/v2/openapi

Retrieves a WebSocket authentication key that expires every 7 days. This endpoint is intended for RapidAPI users.

```APIDOC
/v2/websocket-key:
  servers:
    - url: https://insightsentry.p.rapidapi.com/
      description: Only for RapidAPI users.
  parameters: []
  get:
    summary: Get WebSocket authentication key
    description: Retrieve WebSocket Key, which expires every 7 days. This is only for RapidAPI users
    responses:
      200:
        description: success
        content:
          application/json:
            schema:
              type: object
              properties:
                api_key:
                  type: string
                expiration:
                  type: integer
                  description: Unix timestamp (seconds) when the key expires
                note:
                  type: string
```

--------------------------------

### API: Get Option Chain by Expiration

Source: https://insightsentry.com/docs/v2/openapi

Retrieves option chain data for a specific expiration date. Requires a symbol code and an expiration date.

```APIDOC
"get": {
  "summary": "Option chain by expiration",
  "description": "Retrieve option chain data for a specific expiration date",
  "parameters": [
    {
      "$ref": "#/components/parameters/SymbolCodeQueryParam"
    },
    {
      "name": "expiration",
      "in": "query",
      "required": true,
      "description": "(Required) Expiration Date",
      "example": "2027-06-17",
      "schema": {
        "type": "string",
        "format": "date",
        "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$"
      }
    },
    {
      "$ref": "#/components/parameters/SortByParam"
    },
    {
      "$ref": "#/components/parameters/SortOrderParam"
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/OptionDataResponse"
    }
  }
}
```

--------------------------------

### API: Get Option Historical Data

Source: https://insightsentry.com/docs/v2/openapi

Retrieves historical OHLCV data for option contracts. Requires an option symbol code obtained from the `/v2/options/list` endpoint.

```APIDOC
"get": {
  "summary": "Option historical data",
  "description": "Retrieve historical OHLCV data for option contracts",
  "parameters": [
    {
      "name": "code",
      "in": "query",
      "required": true,
      "description": "(Required) Option symbol code in OPRA: format. You can find this option code from `/v2/options/list?code=${symbol}` endpoint.",
      "example": "OPRA:AAPL271217P205.0",
      "schema": {
        "type": "string",
        "pattern": "^OPRA:[A-Z0-9]+[0-9]{6}[CP][0-9.]+$"
      }
    },
    {
      "$ref": "#/components/parameters/BarTypeParam"
    },
    {
      "$ref": "#/components/parameters/BarIntervalParam"
    },
    {
      "$ref": "#/components/parameters/ExtendedParam"
    },
    {
      "$ref": "#/components/parameters/DividendAdjustmentParam"
    },
    {
      "$ref": "#/components/parameters/BackAdjustmentParam"
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/HistoricalDataResponse"
    }
  }
}
```

--------------------------------

### InsightsEntry V2 API Parameters

Source: https://insightsentry.com/docs/v2/openapi

This section details the various query parameters available for the InsightsEntry V2 API. It includes parameters for specifying the symbol code, bar type and interval, extended hours trading, dividend and back-adjustments, week range, sorting options, and the number of data points.

```APIDOC
SymbolCodeQueryParam:
  name: code
  in: query
  required: true
  description: "(Required) Symbol code"
  example: "NASDAQ:AAPL"
  schema:
    $ref: "#/components/schemas/SymbolCode"

BarTypeParam:
  name: bar_type
  in: query
  required: false
  description: "(Optional) Bar type. Default is 'day'"
  example: "day"
  schema:
    type: string
    default: "day"
    enum:
      - tick
      - second
      - minute
      - hour
      - day
      - week
      - month

BarIntervalParam:
  name: bar_interval
  in: query
  required: false
  description: "(Optional) Bar intervals. The combination of bar_type and bar_interval must not exceed one year. Default is 1."
  example: 1
  schema:
    type: integer
    default: 1
    minimum: 1
    maximum: 1440

ExtendedParam:
  name: extended
  in: query
  required: false
  description: "(Optional) Extended hours (Not all assets support extended hours). Default to true."
  example: "true"
  schema:
    type: boolean
    default: true

DividendAdjustmentParam:
  name: dadj
  in: query
  required: false
  description: "(Optional) Dividend adjustment for equities and etfs (has no effect on assets without dividends). Default to false."
  schema:
    type: boolean
    default: false

BackAdjustmentParam:
  name: badj
  in: query
  required: false
  description: "(Optional) Back-adjustment for continous futures contracts (has no effect on non-continous futures data). Default to true."
  schema:
    type: boolean
    default: true

WeekRangeParam:
  name: w
  in: query
  required: false
  description: "Specifies the week range. For example, 1 means this week (starting today) through next week, 2 means next week through the following week, and so on."
  example: "1"
  schema:
    type: integer
    default: 1
    minimum: 1

SortByParam:
  name: sortBy
  in: query
  required: false
  description: "(Optional) Sort by specified field"
  example: "type"
  schema:
    type: string
    default: "type"
    enum:
      - type
      - ask_price
      - bid_price
      - delta
      - gamma
      - expiration
      - implied_volatility
      - rho
      - strike_price
      - theoretical_price
      - theta
      - vega

SortOrderParam:
  name: sort
  in: query
  required: false
  description: "(Optional) Sort order"
  example: "asc"
  schema:
    type: string
    default: "asc"
    enum:
      - asc
      - desc

DataPointsParam:
  name: dp
  in: query
  required: false
  description: "(Optional) Maximum number of data points to return. Higher values may increase latency. Default is 20000."
  example: "20000"
  schema:
    type: integer
    default: 20000
    minimum: 1
    maximum: 22000

DataPointsParamMin:
  name: dp
  in: query
  required: false
  description: "(Optional) Maximum number of data points to return. Higher values may increase latency. Default is 1."
  example: "1"
  schema:
    type: integer
    default: 1
    minimum: 1
    maximum: 22000

HistoricalDataResponse:
  description: "Successful historical data response"
  headers:
    x-server-location:
      description: "Server location identifier"
      schema:
        type: string
        example: "R:ASIA-SOUTHEAST"
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/HistoricalDataResponse"
```

--------------------------------

### Bond Screener API

Source: https://insightsentry.com/docs/v2/openapi

Provides endpoints to retrieve available bond screener parameters and to screen for bond data based on specified criteria. Supports filtering by fields, exchanges, and countries, with options for pagination and sorting.

```APIDOC
GET /v2/screeners/bond
  Summary: Get available bond screener parameters
  Description: Retrieve the list of available fields and parameters for bond screening.
  Parameters: []
  Responses:
    200:
      $ref: "#/components/responses/ScreenerParametersResponse"

POST /v2/screeners/bond
  Summary: Bond Screener
  Description: Retrieve bond data based on specified filter criteria.
  Parameters: []
  Responses:
    200:
      $ref: "#/components/responses/ScreenerDataResponse"
  RequestBody:
    content:
      application/json:
        schema:
          allOf:
            - $ref: "#/components/schemas/ScreenerRequest"
            - description: "Flexible request body similar to GraphQL. You can include any filter criteria beyond the fixed properties (fields, exchanges, countries, page, sortBy, sortOrder). Common examples include: yield_min, yield_max, duration_min, duration_max, credit_rating, maturity_date_range, etc."
        example:
          fields: ["close_percent", "yield_to_maturity", "volume"]
          exchanges: []
          countries: ["US"]
          page: 1
          sortBy: "yield_to_maturity"
          sortOrder: "desc"
```

--------------------------------

### API Schemas - Quotes, Options, Dividends, Screener

Source: https://insightsentry.com/docs/v2/openapi

This entry consolidates various API response schemas including QuotesResponseData, OptionListResponseData, OptionDataResponseData, ScreenerParametersResponseData, ScreenerDataResponseData, and DividendResponseData. It also includes nested schemas like DividendData, SymbolCode, and UnixTimestampMs, providing a comprehensive view of the data structures returned by the API.

```APIDOC
QuotesResponseData:
  type: object
  description: Quotes response data schema
  properties:
    total_items: { type: integer }
    data: { type: array, items: { $ref: "#/components/schemas/QuoteData" } }

OptionListResponseData:
  type: object
  description: Option list response data schema
  properties:
    last_update: { $ref: "#/components/schemas/UnixTimestampMs" }
    codes: { type: array, items: { $ref: "#/components/schemas/SymbolCode" } }

OptionDataResponseData:
  type: object
  description: Option data response schema
  properties:
    underlying_code: { $ref: "#/components/schemas/SymbolCode" }
    last_update: { $ref: "#/components/schemas/UnixTimestampMs" }
    data: { type: array, items: { $ref: "#/components/schemas/OptionData" } }

ScreenerParametersResponseData:
  type: object
  description: Screener parameters response data schema
  properties:
    available_fields: { type: array, items: { type: string } }
    available_exchanges: { type: array, items: { type: string } }
    available_countries: { type: array, items: { type: string } }
    sortOrder: { type: array, items: { type: string } }

ScreenerDataResponseData:
  allOf:
    - { $ref: "#/components/schemas/PaginatedResponse" }
    - type: object
      properties:
        data: { type: array, items: { type: object, additionalProperties: true, description: "Flexible data object containing the requested fields" } }

DividendResponseData:
  type: object
  description: Dividend calendar response data schema
  properties:
    total_count: { type: integer }
    range: { type: string }
    last_update: { type: integer }
    data: { type: array, items: { $ref: "#/components/schemas/DividendData" } }

DividendData:
  type: object
  description: Individual dividend record
  properties:
    code: { $ref: "#/components/schemas/SymbolCode" }
    dividend_ex_date_recent: { type: integer }
    dividend_ex_date_upcoming: { type: integer }
    name: { type: string }
    dividends_yield: { type: number }
    dividend_payment_date_recent: { type: integer }
    dividend_payment_date_upcoming: { type: integer }
    dividend_amount_recent: { type: number }
    dividend_amount_upcoming: { type: number }
    currency_code: { type: string }
    country: { type: string }
```

--------------------------------

### Profitability Metrics Schema

Source: https://insightsentry.com/docs/v2/openapi

Defines the structure for profitability metrics, including gross margin, operating margin, and pre-tax margin. These metrics are provided for current periods, fiscal years (FY), fiscal quarters (FQ), and trailing twelve months (TTM). Historical data for FY and FQ are supplied as arrays of numbers.

```APIDOC
{
  "type": "object",
  "properties": {
    "gross_margin": {"type": "number"},
    "gross_margin_current": {"type": "number"},
    "gross_margin_fy": {"type": "number"},
    "gross_margin_fq": {"type": "number"},
    "gross_margin_ttm": {"type": "number"},
    "gross_margin_fy_h": {"type": "array", "items": {"type": "number"}},
    "gross_margin_fq_h": {"type": "array", "items": {"type": "number"}},
    "operating_margin": {"type": "number"},
    "operating_margin_current": {"type": "number"},
    "operating_margin_fy": {"type": "number"},
    "operating_margin_fq": {"type": "number"},
    "operating_margin_ttm": {"type": "number"},
    "operating_margin_fy_h": {"type": "array", "items": {"type": "number"}},
    "operating_margin_fq_h": {"type": "array", "items": {"type": "number"}},
    "pre_tax_margin": {"type": "number"},
    "pre_tax_margin_current": {"type": "number"},
    "pre_tax_margin_fy": {"type": "number"},
    "pre_tax_margin_fq": {"type": "number"},
    "pre_tax_margin_ttm": {"type": "number"},
    "pre_tax_margin_fy_h": {"type": "array", "items": {"type": "number"}},
    "pre_tax_margin_fq_h": {"type": "array", "items": {"type": "number"}}
  }
}
```

--------------------------------

### Get Recent Historical Data

Source: https://insightsentry.com/docs/v2/openapi

Retrieves recent historical OHLCV (Open, High, Low, Close, Volume) data for a specified symbol. Supports configurable time intervals and adjustments for dividends and stock splits.

```APIDOC
paths:
  /v2/symbols/{symbol}/history:
    parameters:
      - $ref: "#/components/parameters/SymbolPathParam"
    get:
      summary: Recent historical data (up to 22k bars)
      description: Retrieve recent historical OHLCV data for a symbol with configurable time intervals and adjustments
      parameters:
        - $ref: "#/components/parameters/BarTypeParam"
        - $ref: "#/components/parameters/BarIntervalParam"
        - $ref: "#/components/parameters/ExtendedParam"
        - $ref: "#/components/parameters/DividendAdjustmentParam"
        - $ref: "#/components/parameters/BackAdjustmentParam"
        - $ref: "#/components/parameters/DataPointsParam"
      responses:
        200:
          $ref: "#/components/responses/HistoricalDataResponse"
```

--------------------------------

### API Responses - InsightsEntry V2

Source: https://insightsentry.com/docs/v2/openapi

Defines the structure for various API responses including Quotes, OptionList, OptionData, ScreenerParameters, ScreenerData, Dividend, Earnings, EconomicEvents, and Newsfeed. Each response is expected in JSON format and references specific schema definitions.

```APIDOC
QuotesResponse:
  description: Successful quotes response
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/QuotesResponseData"

OptionListResponse:
  description: Available option contracts
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/OptionListResponseData"

OptionDataResponse:
  description: Option chain data
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/OptionDataResponseData"

ScreenerParametersResponse:
  description: Available screener parameters
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/ScreenerParametersResponseData"

ScreenerDataResponse:
  description: Screener results
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/ScreenerDataResponseData"

DividendResponse:
  description: Dividend calendar data
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/DividendResponseData"

EarningsResponse:
  description: Earnings calendar data
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/EarningsResponseData"

EconomicEventsResponse:
  description: Economic events calendar data
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/EconomicEventsResponseData"

NewsfeedResponse:
  description: Newsfeed data
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/NewsfeedResponseData"
```

--------------------------------

### Symbol Search API (v3)

Source: https://insightsentry.com/docs/v2/openapi

Searches for financial instruments with support for filtering by query, type, country, and pagination. This v3 endpoint provides paginated results.

```APIDOC
GET /v3/symbols/search

Summary: Search for symbols
Description: Search for financial instruments. This v3 endpoint differs from /v2/symbols/search. Use /v3 for paginated search results.
Parameters:
  - name: query
    in: query
    required: false
    description: Search query string
    example: apple
    schema: {
      "type": "string"
    }
  - name: type
    in: query
    required: false
    example: stock
    description: Filter by instrument type
    schema: {
      "type": "string",
      "enum": [
        "crypto",
        "index",
        "forex",
        "futures",
        "stock",
        "economic",
        "common_stock",
        "depository_receipt",
        "fund",
        "preferred_stock",
        "warrant",
        "none"
      ]
    }
  - name: country
    in: query
    required: false
    example: US
    description: Filter by country. 2-letter ISO code
    schema: {
      "type": "string"
    }
  - name: page
    in: query
    required: false
    example: 1
    description: Each page returns up to 50 results.
    schema: {
      "type": "integer",
      "minimum": 1
    }
Responses:
  200: {
    description: Successful response with symbol data
    content: {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "current_page",
            "has_more",
            "symbols"
          ],
          "properties": {
            "current_page": {
              "type": "integer",
              "description": "Current page number",
              "minimum": 1
            },
            "has_more": {
              "type": "boolean",
              "description": "Whether there are more results available"
            },
            "symbols": {
              "type": "array",
              "description": "Array of symbol objects",
              "items": {
                "type": "object",
                "required": [
                  "name",
                  "code"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Symbol name"
                  },
                  "code": {
                    "type": "string",
                    "description": "Full symbol code (e.g., NASDAQ:AAPL)"
                  },
                  "type": {
                    "type": "string",
                    "description": "Type of financial instrument"
                  },
                  "exchange": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
```

--------------------------------

### Financial Screener Request Parameters

Source: https://insightsentry.com/docs/v2/openapi

Specifies the parameters for financial screening requests, allowing filtering by fields, exchanges, and countries. Includes validation for field names and limits on the number of fields.

```APIDOC
ScreenerRequest:
  type: object
  description: Base screener request format
  properties:
    fields:
      type: array
      items:
        type: string
        pattern: "^[a-zA-Z0-9_]+$"
        example: "close"
      description: Array of field names to include in the response. You can find available fields in the Get Screener endpoint. At least one field must be specified, up to 10 fields maximum.
    exchanges:
      type: array
      items:
        type: string
        example: "NYSE"
      description: Array of exchange names to filter by (e.g., ["NYSE", "NASDAQ"]). If not specified or empty, no exchange filtering will be applied.
    countries:
      type: array
      items:
        type: string
        example: "US"
      description: Array of country codes to filter by (e.g., ["US", "CA"]). If not specified or empty, no country filtering will be applied.
```

--------------------------------

### InsightsEntry V2 Schema - Price Targets

Source: https://insightsentry.com/docs/v2/openapi

Defines the structure for price target data, including average, estimates, low/high targets, and the date of the estimate.

```APIDOC
{
  "price_targets": {
    "type": "object",
    "properties": {
      "price_target_average": {
        "type": "number"
      },
      "price_target_estimates_num": {
        "type": "integer"
      },
      "price_target_up_num": {
        "type": "integer"
      },
      "price_target_down_num": {
        "type": "integer"
      },
      "price_target_median": {
        "type": "number"
      },
      "price_target_low": {
        "type": "integer"
      },
      "price_target_high": {
        "type": "integer"
      },
      "price_target_date": {
        "type": "string",
        "format": "date"
      }
    }
  }
}
```

--------------------------------

### Real-time Quote Data API

Source: https://insightsentry.com/docs/v2/openapi

Retrieves real-time quote data for up to 10 symbols. Requires a comma-separated list of symbol codes in the format Exchange:Symbol.

```APIDOC
GET /v2/symbols/quotes

Summary: Real-time quote data
Description: Retrieve real-time quote data for up to 10 symbols
Parameters:
  - name: codes
    in: query
    required: true
    description: Comma-separated list of symbol codes in Exchange:Symbol format. Each code must match the SymbolCode pattern.
    example: CME_MINI:NQ1!,CME_MINI:ES1!,NASDAQ:TSLA
    schema: {
      "type": "string",
      "pattern": "^([A-Z0-9_./]+:[A-Z0-9_./!]+)(,[A-Z0-9_./]+:[A-Z0-9_./!]+)*$"
    }
Responses:
  200: {
    $ref: "#/components/responses/QuotesResponse"
  }
```

--------------------------------

### Financial Equity and Liability Schema

Source: https://insightsentry.com/docs/v2/openapi

Defines the structure for financial metrics related to equity and liabilities. This includes yearly (fy) and quarterly (fq) values, as well as historical data (fy_h, fq_h) represented as arrays of integers. The schema covers common equity, shareholder equity, total equity, total liabilities, minority interest, working capital, net debt, and invested capital.

```json
{
  "type": "integer"
},
"common_equity_total_fy_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"common_equity_total_fq_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"shrhldrs_equity_fy": {
  "type": "integer"
},
"shrhldrs_equity_fq": {
  "type": "integer"
},
"shrhldrs_equity_fy_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"shrhldrs_equity_fq_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"total_equity_fy": {
  "type": "integer"
},
"total_equity_fq": {
  "type": "integer"
},
"total_equity_fy_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"total_equity_fq_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"total_liabilities_shrhldrs_equity_fy": {
  "type": "integer"
},
"total_liabilities_shrhldrs_equity_fq": {
  "type": "integer"
},
"total_liabilities_shrhldrs_equity_fy_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"total_liabilities_shrhldrs_equity_fq_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"minority_interest_fy": {
  "type": "integer"
},
"minority_interest_fq": {
  "type": "integer"
},
"minority_interest_fy_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"minority_interest_fq_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"working_capital_fy": {
  "type": "integer"
},
"working_capital_fq": {
  "type": "integer"
},
"net_debt_fy": {
  "type": "integer"
},
"net_debt_fq": {
  "type": "integer"
},
"net_debt_fy_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"net_debt_fq_h": {
  "type": "array",
  "items": {
    "type": "integer"
  }
},
"invested_capital_fy": {
  "type": "integer"
},
"invested_capital_fq": {
  "type": "integer"
}
```

--------------------------------

### InsightsEntry V2 API Success Response Schema

Source: https://insightsentry.com/docs/v2/openapi

Defines the structure of a successful API response (HTTP 200) for InsightsEntry V2. It includes a status code, last update timestamp, and detailed company data, encompassing business description, sector, industry, location, website, CEO, employee counts, shareholder counts, founding year, currency, country, region, and fund country code. It also details various valuation ratios such as price-to-earnings and price-to-book, including historical and fiscal year data.

```APIDOC
200:
  description: success
  content:
    application/json:
      schema:
        type: object
        properties:
          code:
            $ref: "#/components/schemas/SymbolCode"
          last_update:
            type: integer
          data:
            type: object
            properties:
              company_info:
                type: object
                properties:
                  business_description:
                    type: string
                  sector:
                    type: string
                  industry:
                    type: string
                  location:
                    type: string
                  web_site_url:
                    type: string
                    format: uri
                  ceo:
                    type: string
                  number_of_employees:
                    type: integer
                  number_of_employees_fy:
                    type: integer
                  number_of_shareholders:
                    type: integer
                  number_of_shareholders_fy:
                    type: integer
                  founded:
                    type: integer
                  currency:
                    type: string
                  country:
                    type: string
                  region:
                    type: string
                  country_code_fund:
                    type: string
              valuation_ratios:
                type: object
                properties:
                  price_earnings:
                    type: number
                  price_earnings_fy:
                    type: number
                  price_earnings_fq:
                    type: number
                  price_earnings_fy_h:
                    type: array
                    items:
                      type: number
                  price_earnings_fq_h:
                    type: array
                    items:
                      type: number
                  price_annual_book:
                    type: number
                  price_book_ratio:
                    type: number
                  price_book_current:
                    type: number
                  price_book_fy:
                    type: number
                  price_book_fq:
                    type: number
                  price_book_fy_h:
                    type: array
                    items:
                      type: number
                  price_book_fq_h:
                    type: array
                    items:
                      type: number
                  price_annual_sales:
                    type: number
```

--------------------------------

### Financial Metrics Schema

Source: https://insightsentry.com/docs/v2/openapi

Defines the structure for financial metrics including net margin, return on assets, return on equity, and return on invested capital. It specifies data types and temporal variations (current, FY, FQ, TTM, historical).

```APIDOC
net_margin: number
net_margin_current: number
net_margin_fy: number
net_margin_fq: number
net_margin_ttm: number
net_margin_fy_h: array[number]
net_margin_fq_h: array[number]
after_tax_margin: number
return_on_assets: number
return_on_assets_current: number
return_on_assets_fy: number
return_on_assets_fq: number
return_on_assets_fy_h: array[number]
return_on_assets_fq_h: array[number]
return_on_equity: number
return_on_equity_current: number
return_on_equity_fy: number
return_on_equity_fq: number
return_on_equity_fy_h: array[number]
return_on_equity_fq_h: array[number]
return_on_invested_capital: number
return_on_invested_capital_current: number
return_on_invested_capital_fy: number
return_on_invested_capital_fq: number
return_on_invested_capital_fy_h: array[number]
return_on_invested_capital_fq_h: array[number]
return_on_tang_equity_fy: number
return_on_tang_equity_fq: number
return_on_total_capital_fy: number
```

--------------------------------

### Option Contract Data Structure

Source: https://insightsentry.com/docs/v2/openapi

Details the data structure for option contracts, including pricing (ask, bid, theoretical), Greeks (delta, gamma, theta, vega, rho), implied volatility, and option type.

```APIDOC
OptionData:
  type: object
  description: Option contract data
  properties:
    ask_price:
      type: number
    bid_price:
      type: number
    delta:
      type: number
    gamma:
      type: number
    implied_volatility:
      type: number
    type:
      type: string
    rho:
      type: number
    strike_price:
      type: integer
    theoretical_price:
      type: number
    theta:
      type: number
    vega:
      type: number
```

--------------------------------

### Income Statement Metrics Schema

Source: https://insightsentry.com/docs/v2/openapi

Defines the structure for various income statement metrics, including different return percentages and EBITDA margins. Metrics are provided for fiscal year (fy), fiscal quarter (fq), and trailing twelve months (ttm), with historical data often available as arrays.

```APIDOC
return_on_total_capital_fq: {
  "type": "number"
},
return_of_invested_capital_percent_ttm: {
  "type": "number"
},
return_on_capital_employed_fy: {
  "type": "number"
},
return_on_capital_employed_fq: {
  "type": "number"
},
ebitda_margin_current: {
  "type": "number"
},
ebitda_margin_fy: {
  "type": "number"
},
ebitda_margin_fq: {
  "type": "number"
},
ebitda_margin_fy_h: {
  "type": "array",
  "items": {
    "type": "number"
  }
},
ebitda_margin_fq_h: {
  "type": "array",
  "items": {
    "type": "number"
  }
},
ebitda_per_employee_fy: {
  "type": "number"
}
```
Tokens:
Raw