openapi: 3.1.0 info: title: EODHD Financial Data API description: Comprehensive API for retrieving financial data including stock prices, fundamentals, calendar events, news, and more from EOD Historical Data (eodhd.com) version: 2.0.0 contact: name: EODHD Support url: https://eodhd.com email: supportlevel1@eodhistoricaldata.com termsOfService: https://eodhd.com/financial-apis/terms-conditions license: name: Proprietary url: https://eodhd.com/financial-apis/terms-conditions servers: - url: https://eodhd.com/api description: Primary API path - url: https://eodhistoricaldata.com/api description: Alternative API path security: - EODHDQueryKey: [] tags: - name: End-of-Day Data description: Historical and current end-of-day price data - name: Fundamentals description: Fundamental data for stocks and companies - name: Live (Delayed) Data description: Delayed real-time stock prices and US delayed quotes - name: Intraday Data description: Intraday historical price data (time-based bars) - name: Calendar description: Calendar events including earnings, IPOs, splits, dividends, and trends - name: Tick Data description: Historical and marketplace tick-level trade data - name: Exchanges description: Exchange information and symbols - name: Economic Data description: Economic events and macro indicators - name: Options description: Options contracts and pricing data - name: News description: Financial news and sentiment analysis - name: Technical description: Technical analysis indicators - name: Screening description: Stock screening tools - name: Dividends & Splits description: Dividend and split history - name: Corporate Actions description: Symbol changes and insider transactions - name: Market Data description: Market capitalization and other market data - name: Logos description: Company and ticker logos - name: User description: User account and subscription information - name: Indices description: S&P/Dow Jones indices data and components - name: US Treasury description: US Treasury interest rates (bills, yields, long-term, real yields) - name: CBOE description: CBOE index data and listings - name: ESG description: Environmental, Social, and Governance ratings (Investverte) - name: Investment Analytics description: Risk scoring, bond analysis, bank financials, reports (PRAAMS) - name: Credit & Sovereign Risk description: Sovereign risk premiums, credit ratings, CDS spreads, and corporate credit metrics - name: Sanctions description: Sanctioned entities, vessels, programs, and sources (OFAC and others) - name: Interest Rates description: Reference rates, central bank policy rates, and funding-stress spreads paths: /bulk-fundamentals/{EXCHANGE}: get: summary: Retrieve bulk fundamental data for an exchange description: Fetches fundamental data in bulk for all symbols on a given exchange. Supports filtering by specific symbols and data sections (General, Highlights, Valuation, etc.). operationId: GetBulkFundamentals parameters: - name: EXCHANGE in: path required: true description: Exchange code (e.g., 'US', 'LSE', 'TO'). schema: type: string - name: symbols in: query required: false description: Comma-separated list of symbols to filter (e.g., 'AAPL,MSFT,GOOGL'). schema: type: string - name: offset in: query required: false description: Offset for pagination (number of records to skip). schema: type: integer default: 0 - name: limit in: query required: false description: Maximum number of records to return (max 500). schema: type: integer default: 500 - name: version in: query required: false description: API version for response format. schema: type: integer - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bulk fundamental data. content: application/json: schema: type: array items: type: object properties: General: type: object properties: Code: type: string Name: type: string Exchange: type: string Sector: type: string Industry: type: string Highlights: type: object properties: MarketCapitalization: type: number EBITDA: type: number PERatio: type: number Valuation: type: object properties: TrailingPE: type: number ForwardPE: type: number '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Exchange not found. tags: - Fundamentals /calendar/dividends: get: summary: Retrieve upcoming dividends calendar description: 'Look up upcoming and historical dividend events. Uses the JSON:API filter/page convention. **At least one of `filter[date_eq]` or `filter[symbol]` is required** — a request without either will return HTTP 422. ' operationId: GetUpcomingDividends parameters: - name: filter[date_eq] in: query required: false description: 'Exact date in ''YYYY-MM-DD'' format. Required if `filter[symbol]` is not present. ' schema: type: string format: date - name: filter[date_from] in: query required: false description: Start date in 'YYYY-MM-DD' format. schema: type: string format: date - name: filter[date_to] in: query required: false description: End date in 'YYYY-MM-DD' format. schema: type: string format: date - name: filter[symbol] in: query required: false description: 'Ticker symbol (e.g., ''AAPL.US''). When provided, `filter[date_eq]` may be omitted. ' schema: type: string - name: page[limit] in: query required: false description: Number of records per page (1-10000). schema: type: integer minimum: 1 maximum: 10000 - name: page[offset] in: query required: false description: Pagination offset (0-1000000). schema: type: integer minimum: 0 maximum: 1000000 - name: fmt in: query required: false description: Output format. Defaults to 'json'. schema: type: string enum: - csv - json default: json responses: '200': description: Successfully retrieved dividends calendar data. content: application/json: schema: type: object properties: meta: type: object description: Pagination and request metadata. data: type: array items: type: object properties: date: type: string format: date description: Dividend ex-date. symbol: type: string description: Ticker symbol. required: - date - symbol links: type: object description: JSON:API pagination links. required: - data example: meta: total: 91 data: - date: '2026-05-11' symbol: AAPL.US - date: '2026-05-12' symbol: MSFT.US links: self: https://eodhd.com/api/calendar/dividends?filter[symbol]=AAPL.US '401': description: Unauthorized. Invalid API token. '422': description: 'Validation error. Returned when required filter is missing or parameters are malformed. ' content: application/json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string example: errors: filter: - The filter field is required. filter.date_eq: - The filter.date eq field is required when filter.symbol is not present. tags: - Calendar /calendar/earnings: get: summary: Retrieve upcoming earnings data description: Fetches upcoming earnings data, with optional parameters for date ranges and specific symbols. operationId: GetUpcomingEarnings parameters: - name: from in: query required: false description: Start date for earnings data, in 'YYYY-MM-DD' format. Defaults to today if not provided. schema: type: string format: date - name: to in: query required: false description: End date for earnings data, in 'YYYY-MM-DD' format. Defaults to 7 days from today if not provided. schema: type: string format: date - name: symbols in: query required: false description: Specific symbols to retrieve earnings data for, separated by commas (e.g., 'AAPL.US,MSFT.US'). Overrides the 'from' and 'to' parameters if used. schema: type: string - name: fmt in: query required: false description: Output format, either 'csv' or 'json'. Defaults to 'csv'. schema: type: string enum: - csv - json default: csv responses: '200': description: Successfully retrieved earnings data. content: application/json: schema: type: object properties: type: type: string description: Type of data, e.g., 'Earnings'. description: type: string description: Description of the data, e.g., 'Historical and upcoming Earnings'. from: type: string format: date description: Start date for the earnings data. to: type: string format: date description: End date for the earnings data. earnings: type: array items: type: object properties: code: type: string description: Ticker symbol of the company. report_date: type: string format: date description: Date the earnings report was released. date: type: string format: date description: End date of the fiscal period. before_after_market: type: string description: Indicates whether the earnings report was released 'BeforeMarket' or 'AfterMarket'. currency: type: string description: Currency of the earnings values. actual: type: number description: Actual reported earnings per share or other metric. estimate: type: number description: Estimated earnings per share or other metric. difference: type: number description: Difference between actual and estimated values. percent: type: number description: Percentage difference between actual and estimated values. required: - code - report_date - date - currency example: type: Earnings description: Historical and upcoming Earnings from: '2018-12-02' to: '2018-12-05' earnings: - code: AAPL.US report_date: '2023-02-02' date: '2022-12-31' before_after_market: AfterMarket currency: USD actual: 1.88 estimate: 1.94 difference: -0.06 percent: -3.0928 - code: MSFT.US report_date: '2023-04-25' date: '2023-03-31' before_after_market: AfterMarket currency: USD actual: 2.45 estimate: 2.23 difference: 0.22 percent: 9.8655 '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Earnings data not found for the specified parameters. tags: - Calendar /calendar/ipos: get: summary: Retrieve upcoming IPO data description: Fetches historical and upcoming IPOs for specified date ranges. operationId: GetUpcomingIPOs parameters: - name: from in: query required: false description: Start date for IPO data in 'YYYY-MM-DD' format. Defaults to today if not provided. schema: type: string format: date - name: to in: query required: false description: End date for IPO data in 'YYYY-MM-DD' format. Defaults to 7 days from today if not provided. schema: type: string format: date - name: fmt in: query required: false description: 'Output format. Possible values: ''csv'' for CSV and ''json'' for JSON. Defaults to ''csv''.' schema: type: string enum: - csv - json default: csv responses: '200': description: Successfully retrieved IPO data. content: application/json: schema: type: object properties: type: type: string description: Response type, here 'IPOs'. description: type: string description: Description of the response data. from: type: string format: date description: The start date for the IPO data. to: type: string format: date description: The end date for the IPO data. ipos: type: array items: type: object properties: code: type: string description: Ticker symbol of the IPO if available. name: type: string description: Name of the company going public. exchange: type: string description: Exchange where the IPO will be listed. currency: type: string description: Currency used for the IPO pricing. start_date: type: string format: date description: Expected start date for trading. filing_date: type: string format: date description: Date when the IPO was filed. amended_date: type: string format: date description: Date when the IPO filing was amended. price_from: type: number format: float description: Lower end of the price range. price_to: type: number format: float description: Upper end of the price range. offer_price: type: number format: float description: Final offer price. shares: type: integer description: Number of shares being offered. deal_type: type: string description: Status of the IPO, e.g., 'Filed', 'Priced', 'Expected', or 'Amended'. required: - name - exchange - currency - deal_type example: type: IPOs description: Historical and upcoming IPOs from: '2018-12-02' to: '2018-12-06' ipos: - code: 603629.SHG name: Jiangsu Lettall Electn Co Ltd exchange: Shanghai currency: CNY start_date: '2018-12-11' filing_date: '2017-06-15' amended_date: '2018-12-03' price_from: 0 price_to: 0 offer_price: 0 shares: 25000000 deal_type: Expected - code: N/A name: Gsp Resource Corp exchange: TSXV currency: CAD start_date: '2018-12-03' filing_date: '2018-08-13' amended_date: '2018-11-29' price_from: 0.1523 price_to: 0.1523 offer_price: 0.2 shares: 2500000 deal_type: Priced '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: No IPO data found for the specified date range. tags: - Calendar /calendar/splits: get: summary: Retrieve upcoming and historical stock splits description: Fetches information on stock splits for specified date ranges. operationId: GetUpcomingSplits parameters: - name: from in: query required: false description: Start date for split data in 'YYYY-MM-DD' format. Defaults to today if not provided. schema: type: string format: date - name: to in: query required: false description: End date for split data in 'YYYY-MM-DD' format. Defaults to 7 days from today if not provided. schema: type: string format: date - name: fmt in: query required: false description: Output format, either 'csv' or 'json'. Default is 'csv'. schema: type: string enum: - csv - json default: csv responses: '200': description: Successfully retrieved split data. content: application/json: schema: type: object properties: type: type: string description: Response type, here 'Splits'. description: type: string description: Description of the response data. from: type: string format: date description: The start date for the split data. to: type: string format: date description: The end date for the split data. splits: type: array items: type: object properties: code: type: string description: Ticker symbol of the stock undergoing the split. split_date: type: string format: date description: The date when the stock split takes effect. optionable: type: string enum: - Y - N description: Indicates if the stock is optionable ('Y' for yes, 'N' for no). old_shares: type: integer description: The number of shares before the split. new_shares: type: integer description: The number of shares after the split. required: - code - split_date - old_shares - new_shares example: type: Splits description: Historical and upcoming splits from: '2018-12-02' to: '2018-12-06' splits: - code: AINV.US split_date: '2018-12-03' optionable: N old_shares: 3 new_shares: 1 - code: SDV.AU split_date: '2018-12-03' optionable: N old_shares: 10 new_shares: 1 - code: 1604.TW split_date: '2018-12-04' optionable: N old_shares: 1000 new_shares: 800 '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: No split data found for the specified date range. tags: - Calendar /calendar/trends: get: summary: Retrieve earnings trends data description: Fetches historical and upcoming earnings trends, including EPS and revenue estimates, trends, and revisions for specific stock symbols. operationId: GetEarningsTrends parameters: - name: symbols in: query required: true description: Comma-separated list of stock symbols to retrieve trends data for (e.g., 'AAPL.US,MSFT.US'). schema: type: string - name: fmt in: query required: false description: Output format. Currently supports only 'json'. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved earnings trends data. content: application/json: schema: type: object properties: type: type: string description: Response type, here 'Trends'. description: type: string description: Description of the response data. symbols: type: string description: Symbols for which data is returned. trends: type: array items: type: array items: type: object properties: code: type: string description: Stock symbol for which trend data is returned. date: type: string format: date description: Period end date for the trend data. period: type: string description: Period for the earnings trend (e.g., '+1y', '0y', '+1q', '0q'). growth: type: string description: Expected EPS growth as a decimal. earningsEstimateAvg: type: string description: Average EPS estimate from analysts. earningsEstimateLow: type: string description: Lowest EPS estimate from analysts. earningsEstimateHigh: type: string description: Highest EPS estimate from analysts. earningsEstimateYearAgoEps: type: string description: EPS estimate from the previous year. earningsEstimateNumberOfAnalysts: type: string description: Number of analysts contributing to the EPS estimate. earningsEstimateGrowth: type: string description: Expected EPS growth, same as 'growth'. revenueEstimateAvg: type: string description: Average revenue estimate from analysts. revenueEstimateLow: type: string description: Lowest revenue estimate from analysts. revenueEstimateHigh: type: string description: Highest revenue estimate from analysts. revenueEstimateYearAgoEps: type: string description: Revenue estimate from the previous year. revenueEstimateNumberOfAnalysts: type: string description: Number of analysts contributing to the revenue estimate. revenueEstimateGrowth: type: string description: Expected growth in revenue. epsTrendCurrent: type: string description: Current EPS estimate. epsTrend7daysAgo: type: string description: EPS estimate 7 days ago. epsTrend30daysAgo: type: string description: EPS estimate 30 days ago. epsTrend60daysAgo: type: string description: EPS estimate 60 days ago. epsTrend90daysAgo: type: string description: EPS estimate 90 days ago. epsRevisionsUpLast7days: type: string description: Number of upward EPS revisions in the last 7 days. epsRevisionsUpLast30days: type: string description: Number of upward EPS revisions in the last 30 days. epsRevisionsDownLast7days: type: string description: Number of downward EPS revisions in the last 7 days. epsRevisionsDownLast30days: type: string description: Number of downward EPS revisions in the last 30 days. required: - code - date - period - earningsEstimateAvg example: type: Trends description: Historical and upcoming earning trends symbols: AAPL.US trends: - - code: AAPL.US date: '2025-09-30' period: +1y growth: '0.1200' earningsEstimateAvg: '7.4700' earningsEstimateLow: '6.8800' earningsEstimateHigh: '7.9300' earningsEstimateYearAgoEps: '6.6700' earningsEstimateNumberOfAnalysts: '42' earningsEstimateGrowth: '0.1200' revenueEstimateAvg: '420689000000.00' revenueEstimateLow: '401691000000.00' revenueEstimateHigh: '441882000000.00' revenueEstimateYearAgoEps: '' revenueEstimateNumberOfAnalysts: '40' revenueEstimateGrowth: '0.0780' epsTrendCurrent: '7.4700' epsTrend7daysAgo: '7.4800' epsTrend30daysAgo: '7.4800' epsTrend60daysAgo: '7.4800' epsTrend90daysAgo: '7.3400' epsRevisionsUpLast7days: '1' epsRevisionsUpLast30days: '4' epsRevisionsDownLast30days: '3' '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Earnings trends data not found for the specified symbols. tags: - Calendar /commodities/historical/{code}: get: summary: Get historical commodity prices description: Returns historical price data for a specific commodity by its code (e.g., WTI, BRENT, NATURAL_GAS). operationId: GetCommodityHistoricalData parameters: - name: code in: path required: true description: Commodity code (e.g., 'WTI', 'BRENT', 'NATURAL_GAS', 'GOLD', 'SILVER', 'COPPER', 'PLATINUM', 'PALLADIUM', 'WHEAT', 'CORN', 'SOYBEANS', 'RICE', 'SUGAR', 'COFFEE', 'COTTON', 'COCOA', 'OATS', 'LUMBER', 'RUBBER', 'ETHANOL', 'PROPANE', 'URANIUM', 'COAL'). schema: type: string - name: interval in: query required: false description: Data interval — 'daily' (default), 'weekly', or 'monthly'. schema: type: string enum: - daily - weekly - monthly default: daily - name: from in: query required: false description: Start date in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date in 'YYYY-MM-DD' format. schema: type: string format: date - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved commodity historical data. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Data date. open: type: number description: Opening price. high: type: number description: High price. low: type: number description: Low price. close: type: number description: Closing price. adjusted_close: type: number description: Adjusted closing price. volume: type: number description: Trading volume. '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Commodity not found. tags: - Economic Data /credit-risk/sovereign/risk-premium: get: summary: Get sovereign country risk premiums description: Returns country-level default spreads, country risk premiums, equity risk premiums, corporate tax rates, and related sovereign credit metrics. operationId: GetSovereignRiskPremium parameters: - name: filter[country] in: query required: false description: Filter by country name or ISO Alpha-3 code (e.g., 'USA' or 'Germany'). schema: type: string - name: filter[region] in: query required: false description: Filter by region name. schema: type: string - name: filter[as_of] in: query required: false description: Filter by the as-of date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved sovereign risk premium data. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: country_iso3: type: string description: ISO Alpha-3 country code. country_name: type: string description: Country name. as_of_date: type: string format: date-time description: As-of timestamp for the values. moodys_rating: type: string description: Moody's sovereign credit rating. adj_default_spread: type: number description: Adjusted default spread. country_risk_premium: type: number description: Country risk premium. equity_risk_premium: type: number description: Total equity risk premium. corporate_tax_rate: type: number description: Corporate tax rate. sovereign_cds: type: - number - 'null' description: Sovereign CDS spread, if available. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Credit & Sovereign Risk /credit-risk/sovereign/credit-ratings: get: summary: Get sovereign credit ratings description: Returns sovereign credit ratings by country from Moody's, S&P, and Fitch. operationId: GetSovereignCreditRatings parameters: - name: filter[country] in: query required: false description: Filter by country name or ISO Alpha-3 code (e.g., 'USA' or 'Germany'). schema: type: string - name: filter[as_of] in: query required: false description: Filter by the as-of date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved sovereign credit ratings. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: country_iso3: type: string description: ISO Alpha-3 country code. country_name: type: string description: Country name. as_of_date: type: string format: date-time description: As-of timestamp for the ratings. moodys_rating: type: string description: Moody's sovereign credit rating. sp_rating: type: string description: S&P sovereign credit rating. fitch_rating: type: string description: Fitch sovereign credit rating. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Credit & Sovereign Risk /credit-risk/sovereign/cds-spreads: get: summary: Get sovereign CDS spreads description: Returns sovereign credit default swap (CDS) spreads by country, including spreads net of Switzerland. operationId: GetSovereignCdsSpreads parameters: - name: filter[country] in: query required: false description: Filter by country name or ISO Alpha-3 code (e.g., 'USA' or 'Germany'). schema: type: string - name: filter[as_of] in: query required: false description: Filter by the as-of date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved sovereign CDS spreads. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: country_iso3: type: string description: ISO Alpha-3 country code. country_name: type: string description: Country name. as_of_date: type: string format: date-time description: As-of timestamp for the spreads. moodys_rating: type: string description: Moody's sovereign credit rating. cds_spread: type: - number - 'null' description: Sovereign CDS spread. cds_spread_net_of_switzerland: type: - number - 'null' description: CDS spread net of Switzerland. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Credit & Sovereign Risk /credit-risk/sovereign/default-spreads: get: summary: Get default spreads by rating description: Returns default spreads mapped to credit rating buckets. operationId: GetSovereignDefaultSpreads parameters: - name: filter[rating] in: query required: false description: Filter by credit rating bucket (e.g., 'Aaa', 'Baa2'). schema: type: string - name: filter[as_of] in: query required: false description: Filter by the as-of date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved default spreads by rating. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: rating: type: string description: Credit rating bucket. as_of_date: type: string format: date-time description: As-of timestamp for the spread. default_spread: type: number description: Default spread for the rating bucket. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Credit & Sovereign Risk /credit-risk/corporate/cmdi: get: summary: Get corporate market debt indices (CMDI) description: Returns the Corporate Market Debt Index series, including overall market, investment-grade, and high-yield sub-indices. operationId: GetCorporateCmdi parameters: - name: filter[from] in: query required: false description: Start date (YYYY-MM-DD). schema: type: string format: date - name: filter[to] in: query required: false description: End date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved corporate CMDI data. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: as_of_date: type: string format: date-time description: As-of timestamp for the index values. market_cmdi: type: number description: Overall market CMDI value. ig_cmdi: type: number description: Investment-grade CMDI value. hy_cmdi: type: number description: High-yield CMDI value. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Credit & Sovereign Risk /credit-risk/corporate/hqm-yields: get: summary: Get high quality market (HQM) corporate bond yields description: Returns High Quality Market corporate bond yield curve values (par and spot) across standard tenors. operationId: GetCorporateHqmYields parameters: - name: filter[tenor] in: query required: false description: Filter by tenor in years, single value or comma-separated list (e.g., '10' or '2,5,10'). Allowed values 1, 2, 3, 5, 7, 10, 15, 20, 25, 30. schema: type: string example: 2,5,10 - name: filter[type] in: query required: false description: Yield curve type, single value or comma-separated list (e.g., 'par' or 'par,spot'). Allowed values par, spot (case-insensitive). schema: type: string example: par - name: filter[from] in: query required: false description: Start date (YYYY-MM-DD). schema: type: string format: date - name: filter[to] in: query required: false description: End date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved HQM corporate bond yields. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: series_id: type: string description: Source series identifier. tenor_years: type: number description: Tenor in years. yield_type: type: string description: Yield curve type (par or spot). as_of_date: type: string format: date-time description: As-of timestamp for the yield value. yield_value: type: number description: Yield value. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Credit & Sovereign Risk /credit-risk/cds-market/aggregates: get: summary: Get CDS market aggregate statistics description: Returns aggregated CDS market statistics (e.g., gross notional) broken down by dimensions such as grade or cleared status. operationId: GetCdsMarketAggregates parameters: - name: filter[metric] in: query required: false description: Aggregate metric to return. schema: type: string enum: - gross_notional - name: filter[dimension] in: query required: false description: Breakdown dimension. schema: type: string enum: - grade - cleared_status - name: filter[value] in: query required: false description: Filter by the value of the breakdown dimension. schema: type: string - name: filter[region] in: query required: false description: Filter by region. schema: type: string - name: filter[from] in: query required: false description: Start date (YYYY-MM-DD). schema: type: string format: date - name: filter[to] in: query required: false description: End date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved CDS market aggregates. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: as_of_date: type: string format: date-time description: As-of timestamp for the aggregate. release_date: type: string format: date-time description: Release timestamp of the aggregate. metric: type: string description: Aggregate metric name. breakdown_dimension: type: string description: Dimension used for the breakdown. breakdown_value: type: string description: Value of the breakdown dimension. region: type: string description: Region. usd_notional_mn: type: number description: Notional amount in USD millions. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Credit & Sovereign Risk /cboe/index: get: summary: Get CBOE index historical data description: Returns historical end-of-day data for a specific CBOE index, including daily open, high, low, close values. operationId: GetCBOEIndexData parameters: - name: filter[index_code] in: query required: true description: CBOE index code (e.g., 'VIX', 'SPX'). schema: type: string - name: filter[feed_type] in: query required: true description: Feed type filter. schema: type: string - name: filter[date] in: query required: true description: Date filter in 'YYYY-MM-DD' format. schema: type: string format: date - name: filter[include_review] in: query required: false description: Include review data. schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved CBOE index data. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Trading date. open: type: number description: Opening value. high: type: number description: High value. low: type: number description: Low value. close: type: number description: Closing value. volume: type: number description: Trading volume (if applicable). '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Index not found. tags: - CBOE /cboe/indices: get: summary: List CBOE indices description: Returns a list of all available CBOE indices with their latest values and metadata. operationId: GetCBOEIndices parameters: - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved CBOE indices list. content: application/json: schema: type: array items: type: object properties: code: type: string description: Index symbol code. name: type: string description: Index name. last_value: type: number description: Latest index value. change: type: number description: Change from previous close. change_p: type: number description: Percentage change. last_update: type: string format: date description: Date of last update. '401': description: Unauthorized. Invalid API token. '429': description: Too Many Requests. tags: - CBOE /div/{ticker}: get: summary: Retrieve historical dividend data description: Fetches historical dividend data for a specified stock symbol, including key dividend dates and values. operationId: GetHistoricalDividends parameters: - name: ticker in: path required: true description: Ticker symbol of the stock in the format {SYMBOL_NAME}.{EXCHANGE_ID} (e.g., 'AAPL.US' for NASDAQ or 'AAPL.MX' for the Mexican Stock Exchange). schema: type: string - name: from in: query required: false description: Start date for data retrieval in 'YYYY-MM-DD' format. Defaults to earliest available data if not provided. schema: type: string format: date - name: to in: query required: false description: End date for data retrieval in 'YYYY-MM-DD' format. Defaults to latest available data if not provided. schema: type: string format: date - name: fmt in: query required: false description: Output format, either 'json' or 'csv'. Defaults to 'json'. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved historical dividend data. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Ex-dividend date. declarationDate: type: string format: date description: Declaration date of the dividend. recordDate: type: string format: date description: Record date for dividend eligibility. paymentDate: type: string format: date description: Dividend payment date. period: type: string description: Dividend period (e.g., 'Quarterly'). value: type: number format: float description: Dividend value per share in the specified currency. unadjustedValue: type: number format: float description: Unadjusted dividend value before stock splits and other adjustments. currency: type: string description: Currency in which the dividend is paid (e.g., 'USD'). required: - date - value - currency example: - date: '2012-08-09' declarationDate: '2012-07-24' recordDate: '2012-08-13' paymentDate: '2012-08-16' period: Quarterly value: 0.0946 unadjustedValue: 2.6488 currency: USD - date: '2012-11-07' declarationDate: '2012-10-25' recordDate: '2012-11-12' paymentDate: '2012-11-15' period: Quarterly value: 0.0946 unadjustedValue: 2.6488 currency: USD '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Dividend data not found for the specified ticker or date range. tags: - Dividends & Splits /economic-events: get: summary: Retrieve economic events data description: Fetches economic events by date range, country, comparison type, and other optional parameters. operationId: GetEconomicEventsData parameters: - name: from in: query required: false description: Start date for data retrieval in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date for data retrieval in 'YYYY-MM-DD' format. schema: type: string format: date - name: country in: query required: false description: Country code in ISO 3166-1 alpha-2 format, e.g., 'US' for the United States. schema: type: string minLength: 2 maxLength: 2 - name: comparison in: query required: false description: Comparison type, e.g., 'mom' for month-over-month, 'qoq' for quarter-over-quarter, 'yoy' for year-over-year. schema: type: string enum: - mom - qoq - yoy - name: offset in: query required: false description: Data offset, from 0 to 1000. Default is 0. schema: type: integer minimum: 0 maximum: 1000 default: 0 - name: limit in: query required: false description: Number of results to return, from 0 to 1000. Default is 50. schema: type: integer minimum: 0 maximum: 1000 default: 50 responses: '200': description: Successfully retrieved economic events data. content: application/json: schema: type: array items: type: object properties: type: type: string description: Type of economic event, e.g., 'Nonfarm Payrolls'. comparison: type: - string - 'null' description: Comparison type (e.g., 'mom', 'qoq', 'yoy'). period: type: - string - 'null' description: Period associated with the data, e.g., 'May'. country: type: string description: Country code in ISO 3166 format. date: type: string description: Date and time of the event in 'YYYY-MM-DD HH:MM:SS' format. actual: type: - number - 'null' description: Actual reported value for the event. previous: type: - number - 'null' description: Previous value for the event. estimate: type: - number - 'null' description: Estimated value for the event. change: type: - number - 'null' description: Change in value from previous. change_percentage: type: - number - 'null' description: Percentage change in value from previous. example: - type: Participation Rate comparison: '' period: May country: US date: '2022-06-03 16:30:00' actual: 62.3 previous: 62.2 estimate: null change: 0.1 change_percentage: 0.161 - type: Nonfarm Payrolls Private comparison: '' period: May country: US date: '2022-06-03 16:30:00' actual: 333 previous: 405 estimate: 325 change: -72 change_percentage: -17.778 '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: No economic events data found for the specified parameters. tags: - Economic Data /eod/{ticker}: get: summary: Retrieve end-of-day historical price data description: Retrieve end-of-day historical data for a specific company by its ticker symbol, with optional filters for specific data points. operationId: GetEODDataByTicker parameters: - name: ticker in: path required: true description: Ticker symbol of the company schema: type: string - name: fmt in: query required: false description: Response format (e.g., 'json') schema: type: string enum: - json - csv - name: from in: query required: false description: Start date for historical data (YYYY-MM-DD) schema: type: string format: date - name: to in: query required: false description: End date for historical data (YYYY-MM-DD) schema: type: string format: date - name: period in: query required: false description: Data period (e.g., 'd' for daily, 'w' for weekly, 'm' for monthly) schema: type: string enum: - d - w - m - name: filter in: query required: false description: Filter for specific last known data points schema: type: string enum: - last_date - last_open - last_high - last_low - last_close - last_volume responses: '200': description: Successful response with EOD historical data or single value for filtered data content: application/json: schema: oneOf: - type: array items: type: object properties: date: type: string format: date open: type: number high: type: number low: type: number close: type: number adjusted_close: type: number volume: type: integer - type: number description: Single value for the specified filter query (e.g., last close price) examples: default: summary: Full historical data array example value: - date: '2022-01-03' open: 177.83 high: 182.88 low: 177.71 close: 182.01 adjusted_close: 179.2736 volume: 104487900 - date: '2022-01-04' open: 182.63 high: 182.94 low: 179.12 close: 179.7 adjusted_close: 176.9984 volume: 99310400 filtered_last_close: summary: Filtered last close price example value: 295.21 '400': description: Invalid request parameters '401': description: Unauthorized '404': description: Company or data not found tags: - End-of-Day Data /eod-bulk-last-day/{exchange}: get: summary: Retrieve bulk EOD, splits, or dividends data description: Retrieve bulk end-of-day data, splits, or dividends for an entire exchange or specific tickers, with an option for extended data. operationId: GetBulkEODData parameters: - name: exchange in: path required: true description: Exchange symbol (e.g., 'VI' for Vienna or 'US' for the U.S.). schema: type: string - name: fmt in: query required: false description: Response format ('json' or 'csv'). schema: type: string enum: - json - csv default: json - name: type in: query required: false description: Data type ('eod' for end-of-day data, 'splits' for stock splits, 'dividends' for dividend information). schema: type: string enum: - eod - splits - dividends default: eod - name: date in: query required: false description: Specific date for historical data (YYYY-MM-DD). Defaults to the last trading day. schema: type: string format: date - name: symbols in: query required: false description: Comma-separated list of specific tickers to retrieve data for (e.g., 'MSFT,AAPL'). Only available for EOD data. schema: type: string - name: filter in: query required: false description: Extended filter for additional data such as company name, EMA, etc. Only available in JSON format. schema: type: string enum: - extended responses: '200': description: Successful response with bulk data. content: application/json: schema: oneOf: - type: array items: type: object properties: code: type: string description: Ticker code. exchange_short_name: type: string description: Exchange symbol. date: type: string format: date description: Data date. open: type: number description: Open price. high: type: number description: High price. low: type: number description: Low price. close: type: number description: Close price. adjusted_close: type: number description: Adjusted close price. volume: type: integer description: Trading volume. required: - exchange_short_name - type: array items: type: object properties: code: type: string description: Ticker code. exchange: type: string description: Exchange symbol. date: type: string format: date description: Date of the split. split: type: string description: Stock split ratio. required: - split description: Bulk splits data. - type: array items: type: object properties: code: type: string description: Ticker code. exchange: type: string description: Exchange symbol. date: type: string format: date description: Date of dividend. dividend: type: number description: Dividend amount. currency: type: string description: Dividend currency. declarationDate: type: - string - 'null' format: date description: Declaration date (if available). recordDate: type: - string - 'null' format: date description: Record date (if available). paymentDate: type: - string - 'null' format: date description: Payment date (if available). period: type: - string - 'null' description: Period type (if available). unadjustedValue: type: number description: Unadjusted dividend value. required: - dividend description: Bulk dividends data. examples: default: summary: Bulk EOD data example value: - code: ABIN exchange_short_name: VI date: '2024-11-05' open: 54.28 high: 54.28 low: 53.96 close: 53.96 adjusted_close: 53.96 volume: 11 extended: summary: Extended EOD data example value: - code: MSFT name: Microsoft Corporation type: Common Stock exchange_short_name: US date: '2024-11-05' MarketCapitalization: 3051053121536 Beta: 0.896 open: 408.33 high: 414.9 low: 408.08 close: 411.46 adjusted_close: 411.46 volume: 17429735 ema_50d: 420.793 ema_200d: 408.962 hi_250d: 466.719 lo_250d: 358.003 prev_close: 408.46 change: 3 change_p: 0.7345 avgvol_14d: 21383411 avgvol_50d: 18974565.08 avgvol_200d: 20144592.27 splits: summary: Bulk splits data example value: - code: AQMS exchange: US date: '2024-11-05' split: 1.000000/20.000000 dividends: summary: Bulk dividends data example value: - code: 18RA exchange: F date: '2024-11-05' dividend: 0.07 currency: USD declarationDate: null recordDate: null paymentDate: null period: '' unadjustedValue: 0.07 '400': description: Invalid request parameters. '401': description: Unauthorized request. '404': description: No data found for the specified exchange or date. tags: - End-of-Day Data /exchange-details/{EXCHANGE_CODE}: get: summary: Retrieve details for a specific exchange description: Retrieve exchange details, trading hours, holidays, and active tickers for a specified exchange. operationId: GetExchangeDetails parameters: - name: EXCHANGE_CODE in: path required: true description: Exchange code for which details are to be retrieved (e.g., 'US' for the USA exchange). schema: type: string - name: fmt in: query required: false description: Response format. Options are 'json' and 'csv'. Defaults to JSON. schema: type: string enum: - json - csv - name: from in: query required: false description: Start date for holiday data (YYYY-MM-DD). Defaults to 6 months before the current date. schema: type: string format: date - name: to in: query required: false description: End date for holiday data (YYYY-MM-DD). Defaults to 6 months after the current date. schema: type: string format: date - name: format_version in: query required: false description: Response format version. schema: type: integer responses: '200': description: Successful response with exchange details and trading hours. content: application/json: schema: type: object properties: Name: type: string Code: type: string OperatingMIC: type: string Country: type: string Currency: type: string Timezone: type: string ExchangeHolidays: type: array items: type: object properties: Holiday: type: string Date: type: string format: date Type: type: string ExchangeEarlyCloseDays: type: array items: type: object properties: Date: type: string format: date CloseTime: type: string isOpen: type: boolean TradingHours: type: object properties: Open: type: string Close: type: string OpenUTC: type: string CloseUTC: type: string WorkingDays: type: string ActiveTickers: type: integer PreviousDayUpdatedTickers: type: integer UpdatedTickers: type: integer example: Name: USA Stocks Code: US OperatingMIC: XNAS, XNYS, OTCM Country: USA Currency: USD Timezone: America/New_York ExchangeHolidays: - Holiday: Memorial Day Date: '2024-05-27' Type: official - Holiday: Juneteenth Holiday Date: '2024-06-19' Type: official - Holiday: Independence Day Date: '2024-07-04' Type: official - Holiday: Labour Day Date: '2024-09-02' Type: official - Holiday: Thanksgiving Day Date: '2024-11-28' Type: official - Holiday: Christmas Day Date: '2024-12-25' Type: official - Holiday: New Years Day Date: '2025-01-01' Type: official ExchangeEarlyCloseDays: [] isOpen: false TradingHours: Open: 09:30:00 Close: '16:00:00' OpenUTC: '13:30:00' CloseUTC: '20:00:00' WorkingDays: Mon,Tue,Wed,Thu,Fri ActiveTickers: 49242 PreviousDayUpdatedTickers: 47442 UpdatedTickers: 0 '400': description: Invalid request parameters. '401': description: Unauthorized. '404': description: Exchange not found. tags: - Exchanges /exchange-symbol-list/{exchangeCode}: get: summary: Retrieve the list of tickers for a specific exchange. description: Returns a list of active or delisted symbols for the specified exchange, with optional filters by ticker type. operationId: GetExchangeSymbolList parameters: - name: exchangeCode in: path required: true description: Exchange code, e.g., 'PSE' for the Philippines Stock Exchange or 'US' for combined US exchanges. schema: type: string - name: fmt in: query required: false description: 'Response format. Options: ''json'' (default) or ''csv''.' schema: type: string enum: - json - csv - name: delisted in: query required: false description: Include delisted (inactive) tickers. Set to '1' to include. schema: type: integer enum: - 0 - 1 default: 0 - name: type in: query required: false description: 'Filter by ticker type. Options: ''common_stock'', ''preferred_stock'', ''stock'', ''etf'', ''fund''.' schema: type: string enum: - common_stock - preferred_stock - stock - etf - fund responses: '200': description: Successful response with a list of tickers. content: application/json: schema: type: array items: type: object properties: Code: type: string description: Ticker symbol code. Name: type: string description: Company name associated with the ticker. Country: type: string description: Country of the exchange. Exchange: type: string description: Exchange code. Currency: type: string description: Currency code in which the stock is traded. Type: type: string description: Type of ticker (e.g., Common Stock, ETF). Isin: type: - string - 'null' description: ISIN code if available. example: - Code: AB Name: Atok Big Wedge Co Inc Country: Philippines Exchange: PSE Currency: PHP Type: Common Stock Isin: PHY044931210 - Code: AC Name: Ayala Corp Country: Philippines Exchange: PSE Currency: PHP Type: Common Stock Isin: PHY0486V1154 '400': description: Invalid request parameters. '401': description: Unauthorized. tags: - Exchanges /exchanges-list: get: summary: List supported exchanges description: Retrieve the list of supported exchanges with their details. operationId: GetListOfExchanges parameters: - name: fmt in: query required: false description: Response format. Options are 'json' and 'csv'. Defaults to JSON. schema: type: string enum: - json - csv responses: '200': description: Successful response with a list of exchanges. content: application/json: schema: type: array items: type: object properties: Name: type: string Code: type: string OperatingMIC: type: - string - 'null' Country: type: string Currency: type: string CountryISO2: type: string CountryISO3: type: string example: - Name: USA Stocks Code: US OperatingMIC: XNAS, XNYS, OTCM Country: USA Currency: USD CountryISO2: US CountryISO3: USA - Name: Toronto Exchange Code: TO OperatingMIC: XTSE Country: Canada Currency: CAD CountryISO2: CA CountryISO3: CAN - Name: Berlin Exchange Code: BE OperatingMIC: XBER Country: Germany Currency: EUR CountryISO2: DE CountryISO3: DEU '400': description: Invalid request parameters. '401': description: Unauthorized. tags: - Exchanges /fundamentals/{ticker}: get: summary: Retrieve filtered fundamental data for a specific symbol description: Fetches various sections of fundamental data for a given stock symbol. Use filters to specify the data section and sub-sections, such as Financials::Balance_Sheet::quarterly::2024-06-30 for quarterly Balance Sheet data. operationId: GetFundamentalData parameters: - name: ticker in: path required: true description: The ticker symbol in the format SYMBOL.EXCHANGE, e.g., 'AAPL.US' for Apple Inc. on NASDAQ. schema: type: string - name: filter in: query required: false description: Filter parameter to specify data section and optional sub-sections, e.g., `Financials::Balance_Sheet::quarterly::2024-06-30`. Supported sections include General, Highlights, Valuation, SharesStats, Technicals, SplitsDividends, AnalystRatings, Holders, InsiderTransactions, ESGScores, outstandingShares, Earnings, and Financials. When omitted, returns all sections. schema: type: string example: Financials::Income_Statement::annual::2023-12-31 - name: historical in: query required: false description: Set to 1 to return historical data for certain sections (e.g., outstandingShares). schema: type: integer enum: - 0 - 1 - name: from in: query required: false description: Start date for historical data in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date for historical data in 'YYYY-MM-DD' format. schema: type: string format: date - name: version in: query required: false description: API version for response format. schema: type: integer - name: no_cache in: query required: false description: Set to 1 to bypass cache and get fresh data. schema: type: integer enum: - 0 - 1 responses: '200': description: Successfully retrieved filtered fundamental data for the specified symbol and section. content: application/json: schema: type: object properties: General: type: object description: General company information properties: Code: type: string Name: type: string Exchange: type: string Sector: type: string Highlights: type: object description: Key financial highlights properties: MarketCapitalization: type: number EBITDA: type: number PERatio: type: number Valuation: type: object description: Company valuation metrics properties: TrailingPE: type: number ForwardPE: type: number EnterpriseValue: type: number SharesStats: type: object description: Shares statistics properties: SharesOutstanding: type: number SharesFloat: type: number PercentInstitutions: type: number Technicals: type: object description: Technical indicators properties: Beta: type: number 52WeekHigh: type: number 52WeekLow: type: number SplitsDividends: type: object description: Dividend and split information properties: DividendYield: type: number DividendDate: type: string format: date LastSplitFactor: type: string AnalystRatings: type: object description: Analyst ratings properties: Rating: type: number StrongBuy: type: integer Sell: type: integer Holders: type: object description: Institutional and fund holders properties: Institutions: type: array items: type: object properties: name: type: string totalShares: type: number Funds: type: array items: type: object properties: name: type: string totalShares: type: number InsiderTransactions: type: array description: Insider transactions items: type: object properties: date: type: string format: date ownerName: type: string transactionCode: type: string transactionAmount: type: number ESGScores: type: object description: Environmental, social, and governance scores properties: environmentScore: type: number socialScore: type: number governanceScore: type: number outstandingShares: type: object description: Outstanding shares data properties: annual: type: array items: type: object properties: date: type: string format: date shares: type: number quarterly: type: array items: type: object properties: date: type: string format: date shares: type: number Earnings: type: object description: Earnings data properties: History: type: array items: type: object properties: date: type: string format: date epsActual: type: number Trend: type: array items: type: object properties: period: type: string epsEstimateAvg: type: number Financials: type: object description: Financial statements properties: Balance_Sheet: type: object description: Balance sheet data properties: annual: type: array quarterly: type: array Income_Statement: type: object description: Income statement data properties: annual: type: array quarterly: type: array Cash_Flow: type: object description: Cash flow data properties: annual: type: array quarterly: type: array '400': description: Invalid request parameters or missing required filter. '401': description: Unauthorized. Invalid API token. '404': description: Data not found for the specified symbol or filter. tags: - Fundamentals /id-mapping: get: summary: Map between financial identifiers description: 'Look up securities by various identifiers including symbol, exchange code, ISIN, FIGI, LEI, CUSIP, and CIK. **At least one of the following filter parameters is required**: `filter[symbol]`, `filter[isin]`, `filter[figi]`, `filter[lei]`, `filter[cusip]`, `filter[cik]`, or `filter[ex]`. A request without any of these will return HTTP 422. ' operationId: GetIdMapping parameters: - name: filter[symbol] in: query required: false description: Filter by ticker symbol (e.g., 'AAPL'). schema: type: string - name: filter[ex] in: query required: false description: Filter by exchange code (e.g., 'US'). schema: type: string - name: filter[isin] in: query required: false description: Filter by ISIN code (e.g., 'US0378331005'). schema: type: string - name: filter[figi] in: query required: false description: Filter by FIGI identifier. schema: type: string - name: filter[lei] in: query required: false description: Filter by LEI code. schema: type: string - name: filter[cusip] in: query required: false description: Filter by CUSIP identifier. schema: type: string - name: filter[cik] in: query required: false description: Filter by CIK number. schema: type: string - name: page[limit] in: query required: false description: Number of records per page. schema: type: integer - name: page[offset] in: query required: false description: Pagination offset. schema: type: integer - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved identifier mappings. content: application/json: schema: type: array items: type: object properties: Code: type: string description: Ticker symbol. Exchange: type: string description: Exchange code. Name: type: string description: Company name. ISIN: type: string description: ISIN code. FIGI: type: string description: FIGI identifier. LEI: type: string description: LEI code. CUSIP: type: string description: CUSIP identifier. CIK: type: string description: CIK number. '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. tags: - Exchanges /historical-market-cap/{ticker}: get: summary: Retrieve historical market capitalization data description: Fetches historical market capitalization for a specified stock symbol with weekly frequency. operationId: GetHistoricalMarketCap parameters: - name: ticker in: path required: true description: The ticker symbol of the stock, e.g., 'AAPL.US' or simply 'AAPL'. schema: type: string - name: from in: query required: false description: Start date for data retrieval in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date for data retrieval in 'YYYY-MM-DD' format. schema: type: string format: date - name: reverse in: query required: false description: Set to 'true' to reverse sort order (newest first). schema: type: string enum: - 'true' - 'false' - name: fmt in: query required: false description: Output format, either 'json' or 'csv'. Defaults to 'json'. schema: type: string enum: - json - csv default: json responses: '200': description: 'Successfully retrieved historical market capitalization data. The response is a JSON object whose keys are sequential integer indices (as strings: "0", "1", "2", ...) and whose values are objects containing `date` and `value`. Iterate over the values, not the keys. ' content: application/json: schema: type: object additionalProperties: type: object properties: date: type: string format: date description: The date of the market capitalization value. value: type: number description: Market capitalization value in USD. required: - date - value example: '0': date: '2022-06-07' value: 2406898266500 '1': date: '2022-06-14' value: 2148744629600 '2': date: '2022-06-21' value: 2199080542500 '3': date: '2022-06-28' value: 2212148752300 '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Market capitalization data not found for the specified ticker or date range. tags: - Market Data /insider-transactions: get: summary: Retrieve insider transaction data description: Fetch insider transaction data for US-listed companies. Covers insider buys and sells, providing transaction details such as date, shares, and price. operationId: GetInsiderTransactions parameters: - name: limit in: query required: false description: Max number of entries per result, from 1 to 1000. Default is 100. schema: type: integer minimum: 1 maximum: 1000 default: 100 - name: from in: query required: false description: 'Start date for transactions (format: YYYY-MM-DD). Defaults to one year before current date.' schema: type: string format: date - name: to in: query required: false description: 'End date for transactions (format: YYYY-MM-DD). Defaults to current date.' schema: type: string format: date - name: code in: query required: false description: Ticker symbol for filtering results (e.g., 'AAPL.US'). If omitted, returns data for all symbols. schema: type: string - name: fmt in: query required: false description: Output format (only 'json' supported). schema: type: string enum: - json default: json responses: '200': description: Successful response with insider transaction data content: application/json: schema: type: array items: type: object properties: code: type: string description: Ticker symbol of the company exchange: type: string description: Exchange where the stock is listed date: type: string format: date description: Report date of the transaction reportDate: type: string format: date description: Date the transaction was reported to the SEC ownerCik: type: - string - 'null' description: Unique identifier for the owner in SEC filings ownerName: type: string description: Name of the insider who executed the transaction ownerRelationship: type: - string - 'null' description: Relationship of the owner to the company (e.g., Director) ownerTitle: type: string description: Title or role of the insider in the company transactionDate: type: string format: date description: Date when the transaction occurred transactionCode: type: string enum: - P - S description: 'Type of transaction: ''P'' for Purchase, ''S'' for Sale' transactionAmount: type: integer description: Number of shares involved in the transaction transactionPrice: type: number format: float description: Price per share at the time of the transaction transactionAcquiredDisposed: type: string enum: - A - D description: Indicates whether securities were Acquired (A) or Disposed (D) postTransactionAmount: type: - integer - 'null' description: Total number of shares held by the insider post-transaction link: type: string format: uri description: Link to the original SEC filing document examples: example1: summary: Sample insider transaction data value: - code: AAPL exchange: US date: '2023-03-09' reportDate: '2023-03-13' ownerCik: 0000320193 ownerName: Tim Cook ownerRelationship: CEO ownerTitle: CEO transactionDate: '2023-03-09' transactionCode: P transactionAmount: 5000 transactionPrice: 120.5 transactionAcquiredDisposed: A postTransactionAmount: 5000 link: https://www.sec.gov/Archives/edgar/data/0000320193/000141588922012089/xslF345X03/form4.xml '400': description: Invalid request parameters. '401': description: Unauthorized access, invalid or missing API token. '404': description: No insider transaction data found for the specified criteria. tags: - Corporate Actions /internal-user: get: summary: Retrieve internal user account information description: Fetch detailed internal account information for the authenticated user, including subscription type, usage statistics, and available data feeds. Requires a valid `api_token` as a query parameter. operationId: GetInternalUserInfo responses: '200': description: Successful response with user information. content: application/json: schema: type: object properties: name: type: string description: Full name of the user. email: type: string format: email description: Registered email address. subscriptionType: type: string enum: - monthly - yearly description: Type of subscription plan. paymentMethod: type: string description: Payment processor used for the subscription (e.g., Stripe, PayPal). apiRequests: type: integer description: Number of API requests made during the current counting period. apiRequestsDate: type: string format: date description: Date for which the API request count applies. dailyRateLimit: type: integer description: Daily request limit for standard API usage. extraLimit: type: integer description: Extra daily request limit granted to the user. inviteToken: type: - string - 'null' description: Referral invite token, if available. inviteTokenClicked: type: integer description: Number of times the invite token link was clicked. subscriptionMode: type: string enum: - paid - free - trial description: Current subscription mode. availableDataFeeds: type: array description: List of data feeds included in the subscription. items: type: string availableMarketplaceDataFeeds: type: object description: Marketplace API usage and subscription details. These have a separate request counter from the standard APIs. properties: dailyRateLimit: type: integer description: Daily request limit for marketplace subscriptions. requestsSpent: type: integer description: Number of marketplace API requests made during the current counting period. timeToReset: type: string description: Time remaining until the marketplace API request counter resets. subscriptions: type: array description: List of marketplace subscriptions available to the user. items: type: string example: name: John Doe email: user@example.com subscriptionType: monthly paymentMethod: Stripe apiRequests: 1234 apiRequestsDate: '2025-01-15' dailyRateLimit: 100000 extraLimit: 0 inviteToken: '' inviteTokenClicked: 0 subscriptionMode: paid availableDataFeeds: - Bulk Splits and Dividends API - Fundamental Data - Bond Fundamentals API - Stock Options Data - News API - commodities - sec_filings - id_mapping - Technical API Data - Intraday Data API - EOD Historical Data - Search API - dividends - Dividends Data Feed - Split Data Feed - Calendar Data - Live (delayed) Data API - CBOE Data API - Real-time Data via WebSockets - Economic Events API - Sentiment Data API - Tick Data - Exchanges List API availableMarketplaceDataFeeds: dailyRateLimit: 100000 requestsSpent: 30 timeToReset: 08:53 GMT+0000 subscriptions: - US Stock Options Data API '400': description: Invalid request parameters. '401': description: Unauthorized. The API token is missing, invalid, or expired. '404': description: User not found. tags: - User /intraday/{ticker}: get: summary: Retrieve intraday historical price data description: Retrieve intraday historical stock data for a specific ticker. operationId: GetIntradayHistoricalData parameters: - name: ticker in: path required: true description: Ticker symbol with exchange code (e.g., 'AAPL.US'). schema: type: string - name: interval in: query required: true description: Interval for data points. Options are '1m' (1 minute), '5m' (5 minutes), '15m' (15 minutes), '30m' (30 minutes), and '1h' (1 hour). schema: type: string enum: - 1m - 5m - 15m - 30m - 1h - name: fmt in: query required: false description: Response format. Defaults to CSV if not specified. Options are 'json' and 'csv'. schema: type: string enum: - json - csv - name: from in: query required: false description: Start datetime in Unix timestamp (UTC). For example, 1627896900 for '2021-08-02 09:35:00'. schema: type: integer - name: to in: query required: false description: End datetime in Unix timestamp (UTC). For example, 1630575300 for '2021-09-02 09:35:00'. schema: type: integer responses: '200': description: Successful response with intraday historical stock data. content: application/json: schema: type: array items: type: object properties: timestamp: type: integer gmtoffset: type: integer datetime: type: string open: type: number high: type: number low: type: number close: type: number volume: type: - integer - 'null' example: - timestamp: 1628876100 gmtoffset: 0 datetime: '2021-08-13 17:35:00' open: 148.929992 high: 149.059997 low: 148.929992 close: 149.035003 volume: 416405 - timestamp: 1628876400 gmtoffset: 0 datetime: '2021-08-13 17:40:00' open: 149.0372 high: 149.095001 low: 148.940002 close: 148.976898 volume: 421612 '400': description: Invalid request parameters. '401': description: Unauthorized. '404': description: No data found for the specified ticker or date range. tags: - Intraday Data /logo/{symbol}: get: summary: Get ticker logo (PNG) description: Returns a 200x200 PNG logo (transparent background) for the given ticker symbol, formatted as {ticker}.{exchange} (e.g., AAPL.US). operationId: getTickerLogo parameters: - name: symbol in: path required: true description: Ticker with exchange, e.g., AAPL.US schema: type: string examples: appleUS: value: AAPL.US summary: Apple Inc. on US exchange responses: '200': description: PNG image for the requested ticker. content: image/png: schema: type: string format: binary example: (binary PNG data) '401': description: Unauthorized (invalid token or suspended account). content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden (resource not available for current user). content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found (no logo for symbol). content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests (rate limit exceeded). content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Logos /logo-svg/{symbol}: get: summary: Get ticker logo (SVG) description: Returns an SVG logo for the given ticker symbol, formatted as {ticker}.{exchange} (e.g., AAPL.US). operationId: getTickerLogoSvg parameters: - name: symbol in: path required: true description: Ticker with exchange, e.g., AAPL.US schema: type: string examples: appleUS: value: AAPL.US summary: Apple Inc. on US exchange responses: '200': description: SVG image for the requested ticker. content: image/svg+xml: schema: type: string example: ... '401': description: Unauthorized (invalid token or suspended account). content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden (resource not available for current user). content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found (no logo for symbol). content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests (rate limit exceeded). content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Logos /macro-indicator/{country}: get: summary: Retrieve macroeconomic indicators for a specific country description: Fetches macroeconomic data for a selected indicator, such as GDP or inflation, by country code. operationId: GetMacroIndicatorData parameters: - name: country in: path required: true description: Country code in ISO Alpha-3 format (e.g., 'USA' for United States, 'FRA' for France). schema: type: string - name: indicator in: query required: false description: The macroeconomic indicator to retrieve. Default is 'gdp_current_usd'. schema: type: string enum: - real_interest_rate - population_total - population_growth_annual - inflation_consumer_prices_annual - consumer_price_index - gdp_current_usd - gdp_per_capita_usd - gdp_growth_annual - debt_percent_gdp - net_trades_goods_services - inflation_gdp_deflator_annual - agriculture_value_added_percent_gdp - industry_value_added_percent_gdp - services_value_added_percent_gdp - exports_of_goods_services_percent_gdp - imports_of_goods_services_percent_gdp - gross_capital_formation_percent_gdp - net_migration - gni_usd - gni_per_capita_usd - gni_ppp_usd - gni_per_capita_ppp_usd - income_share_lowest_twenty - life_expectancy - fertility_rate - prevalence_hiv_total - co2_emissions_tons_per_capita - surface_area_km - poverty_poverty_lines_percent_population - revenue_excluding_grants_percent_gdp - cash_surplus_deficit_percent_gdp - startup_procedures_register - market_cap_domestic_companies_percent_gdp - mobile_subscriptions_per_hundred - internet_users_per_hundred - high_technology_exports_percent_total - merchandise_trade_percent_gdp - total_debt_service_percent_gni - unemployment_total_percent default: gdp_current_usd - name: fmt in: query required: false description: 'Output format: ''json'' or ''csv''. Default is ''json''.' schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved macroeconomic data. content: application/json: schema: type: array items: type: object properties: CountryCode: type: string description: ISO Alpha-3 country code, e.g., 'USA' for United States. CountryName: type: string description: Country name, e.g., 'United States'. Indicator: type: string description: Indicator name, e.g., 'Inflation, consumer prices (annual %)'. Date: type: string format: date description: Date of the recorded value. Period: type: string description: Period of the data, e.g., 'Annual'. Value: type: number description: Recorded value of the indicator. example: - CountryCode: USA CountryName: United States Indicator: Inflation, consumer prices (annual %) Date: '2023-12-31' Period: Annual Value: 4.1163 - CountryCode: USA CountryName: United States Indicator: Inflation, consumer prices (annual %) Date: '2022-12-31' Period: Annual Value: 8.0028 '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Data not found for the specified country or indicator. tags: - Economic Data /mp/investverte/companies: get: summary: List ESG-rated companies description: Returns a list of all companies with ESG ratings available from Investverte. operationId: GetESGCompanies parameters: - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved ESG companies list. content: application/json: schema: type: array items: type: object properties: symbol: type: string description: Ticker symbol. name: type: string description: Company name. country: type: string description: Country of domicile. sector: type: string description: Business sector. industry: type: string description: Industry classification. '401': description: Unauthorized. Invalid API token. '429': description: Too Many Requests. tags: - ESG /mp/investverte/countries: get: summary: List ESG country scores description: Returns a list of all countries with their aggregate ESG scores from Investverte. operationId: GetESGCountries parameters: - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved ESG country scores. content: application/json: schema: type: array items: type: object properties: country: type: string description: Country name. country_code: type: string description: ISO country code. esg_score: type: number description: Overall ESG score. environmental_score: type: number description: Environmental pillar score. social_score: type: number description: Social pillar score. governance_score: type: number description: Governance pillar score. num_companies: type: integer description: Number of rated companies in country. '401': description: Unauthorized. Invalid API token. '429': description: Too Many Requests. tags: - ESG /mp/investverte/country/{symbol}: get: summary: Get ESG country details description: Returns detailed ESG scores and metrics for a specific country from Investverte. operationId: GetESGCountryDetails parameters: - name: symbol in: path required: true description: Country code (e.g., 'US', 'GB', 'DE'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved country ESG details. content: application/json: schema: type: object properties: country: type: string description: Country name. country_code: type: string description: ISO country code. esg_score: type: number description: Overall ESG score. environmental_score: type: number description: Environmental pillar score. social_score: type: number description: Social pillar score. governance_score: type: number description: Governance pillar score. top_companies: type: array description: Top ESG-rated companies in this country. items: type: object properties: symbol: type: string name: type: string esg_score: type: number sector_breakdown: type: array description: ESG scores by sector within this country. items: type: object properties: sector: type: string avg_esg_score: type: number num_companies: type: integer '401': description: Unauthorized. Invalid API token. '404': description: Country not found. tags: - ESG /mp/investverte/esg/{symbol}: get: summary: Get ESG rating for a company description: Returns detailed ESG ratings and scores for a specific company from Investverte. operationId: GetESGRating parameters: - name: symbol in: path required: true description: Ticker symbol (e.g., 'AAPL.US'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved ESG rating. content: application/json: schema: type: object properties: symbol: type: string description: Ticker symbol. name: type: string description: Company name. esg_score: type: number description: Overall ESG score. esg_rating: type: string description: ESG rating grade (e.g., 'A', 'BBB', 'CCC'). environmental_score: type: number description: Environmental pillar score. social_score: type: number description: Social pillar score. governance_score: type: number description: Governance pillar score. environmental_details: type: object description: Detailed environmental metrics. social_details: type: object description: Detailed social metrics. governance_details: type: object description: Detailed governance metrics. last_updated: type: string format: date description: Date of last rating update. '401': description: Unauthorized. Invalid API token. '404': description: Company not found or no ESG data available. tags: - ESG /mp/investverte/sector/{symbol}: get: summary: Get ESG sector details description: Returns detailed ESG scores and metrics for a specific sector from Investverte. operationId: GetESGSectorDetails parameters: - name: symbol in: path required: true description: Sector identifier. schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved sector ESG details. content: application/json: schema: type: object properties: sector: type: string description: Sector name. esg_score: type: number description: Overall ESG score. environmental_score: type: number description: Environmental pillar score. social_score: type: number description: Social pillar score. governance_score: type: number description: Governance pillar score. top_companies: type: array description: Top ESG-rated companies in this sector. items: type: object properties: symbol: type: string name: type: string esg_score: type: number country_breakdown: type: array description: ESG scores by country within this sector. items: type: object properties: country: type: string avg_esg_score: type: number num_companies: type: integer '401': description: Unauthorized. Invalid API token. '404': description: Sector not found. tags: - ESG /mp/investverte/sectors: get: summary: List ESG sector scores description: Returns a list of all sectors with their aggregate ESG scores from Investverte. operationId: GetESGSectors parameters: - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved ESG sector scores. content: application/json: schema: type: array items: type: object properties: sector: type: string description: Sector name. esg_score: type: number description: Overall ESG score. environmental_score: type: number description: Environmental pillar score. social_score: type: number description: Social pillar score. governance_score: type: number description: Governance pillar score. num_companies: type: integer description: Number of rated companies in sector. '401': description: Unauthorized. Invalid API token. '429': description: Too Many Requests. tags: - ESG /mp/praams/analyse/bond/{isin}: get: summary: Analyse bond by ISIN description: Returns PRAAMS risk scoring and analysis for a specific bond identified by ISIN. operationId: AnalysePRAAMSBond parameters: - name: isin in: path required: true description: Bond ISIN code. schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bond analysis. content: application/json: schema: type: object properties: isin: type: string name: type: string description: Bond name. risk_score: type: number description: PRAAMS risk score. risk_category: type: string description: Risk category (e.g., 'Low', 'Medium', 'High'). yield_to_maturity: type: number duration: type: number description: Modified duration. convexity: type: number credit_rating: type: string coupon_rate: type: number maturity_date: type: string format: date issuer: type: string '401': description: Unauthorized. Invalid API token. '404': description: Bond not found. tags: - Investment Analytics /mp/praams/analyse/equity/isin/{isin}: get: summary: Analyse equity by ISIN description: Returns PRAAMS risk scoring and analysis for a specific equity identified by ISIN. operationId: AnalysePRAAMSEquityByISIN parameters: - name: isin in: path required: true description: Equity ISIN code. schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved equity analysis. content: application/json: schema: type: object properties: isin: type: string name: type: string risk_score: type: number risk_category: type: string volatility: type: number beta: type: number sharpe_ratio: type: number max_drawdown: type: number sector: type: string market_cap: type: number '401': description: Unauthorized. Invalid API token. '404': description: Equity not found. tags: - Investment Analytics /mp/praams/analyse/equity/ticker/{ticker}: get: summary: Analyse equity by ticker description: Returns PRAAMS risk scoring and analysis for a specific equity identified by ticker. operationId: AnalysePRAAMSEquityByTicker parameters: - name: ticker in: path required: true description: Ticker symbol (e.g., 'AAPL.US'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved equity analysis. content: application/json: schema: type: object properties: ticker: type: string name: type: string risk_score: type: number description: PRAAMS risk score. risk_category: type: string description: Risk category. volatility: type: number beta: type: number sharpe_ratio: type: number max_drawdown: type: number sector: type: string market_cap: type: number '401': description: Unauthorized. Invalid API token. '404': description: Equity not found. tags: - Investment Analytics /mp/praams/bank/balance_sheet/isin/{isin}: get: summary: Get bank balance sheet by ISIN description: Returns bank-specific balance sheet analysis for the specified ISIN from PRAAMS. operationId: GetPRAAMSBankBalanceSheetByISIN parameters: - name: isin in: path required: true description: ISIN code (e.g., 'US46625H1005'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bank balance sheet. content: application/json: schema: type: object properties: isin: type: string name: type: string description: Bank name. total_assets: type: number total_liabilities: type: number total_equity: type: number loans_net: type: number deposits: type: number tier1_capital_ratio: type: number leverage_ratio: type: number periods: type: array items: type: object properties: date: type: string format: date total_assets: type: number total_liabilities: type: number total_equity: type: number '401': description: Unauthorized. Invalid API token. '404': description: Bank data not found. tags: - Investment Analytics /mp/praams/bank/balance_sheet/ticker/{ticker}: get: summary: Get bank balance sheet by ticker description: Returns bank-specific balance sheet analysis for the specified ticker from PRAAMS. operationId: GetPRAAMSBankBalanceSheetByTicker parameters: - name: ticker in: path required: true description: Ticker symbol (e.g., 'JPM.US'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bank balance sheet. content: application/json: schema: type: object properties: ticker: type: string name: type: string description: Bank name. total_assets: type: number total_liabilities: type: number total_equity: type: number loans_net: type: number description: Net loans. deposits: type: number description: Total deposits. tier1_capital_ratio: type: number description: Tier 1 capital ratio. leverage_ratio: type: number periods: type: array items: type: object properties: date: type: string format: date total_assets: type: number total_liabilities: type: number total_equity: type: number '401': description: Unauthorized. Invalid API token. '404': description: Bank data not found. tags: - Investment Analytics /mp/praams/bank/income_statement/isin/{isin}: get: summary: Get bank income statement by ISIN description: Returns bank-specific income statement analysis for the specified ISIN from PRAAMS. operationId: GetPRAAMSBankIncomeByISIN parameters: - name: isin in: path required: true description: ISIN code (e.g., 'US46625H1005'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bank income statement. content: application/json: schema: type: object properties: isin: type: string name: type: string net_interest_income: type: number non_interest_income: type: number provision_for_loan_losses: type: number net_income: type: number return_on_assets: type: number return_on_equity: type: number efficiency_ratio: type: number periods: type: array items: type: object properties: date: type: string format: date net_interest_income: type: number net_income: type: number '401': description: Unauthorized. Invalid API token. '404': description: Bank data not found. tags: - Investment Analytics /mp/praams/bank/income_statement/ticker/{ticker}: get: summary: Get bank income statement by ticker description: Returns bank-specific income statement analysis for the specified ticker from PRAAMS. operationId: GetPRAAMSBankIncomeByTicker parameters: - name: ticker in: path required: true description: Ticker symbol (e.g., 'JPM.US'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bank income statement. content: application/json: schema: type: object properties: ticker: type: string name: type: string net_interest_income: type: number description: Net interest income. non_interest_income: type: number description: Non-interest income. provision_for_loan_losses: type: number net_income: type: number return_on_assets: type: number description: Return on assets (ROA). return_on_equity: type: number description: Return on equity (ROE). efficiency_ratio: type: number periods: type: array items: type: object properties: date: type: string format: date net_interest_income: type: number net_income: type: number '401': description: Unauthorized. Invalid API token. '404': description: Bank data not found. tags: - Investment Analytics /mp/praams/explore/bond: get: summary: Explore bonds description: Search and filter bonds using PRAAMS analytics. Returns a list of bonds matching the specified criteria with risk scores. operationId: ExplorePRAAMSBonds parameters: - name: risk_category in: query required: false description: Filter by risk category (e.g., 'Low', 'Medium', 'High'). schema: type: string - name: min_yield in: query required: false description: Minimum yield to maturity filter. schema: type: number - name: max_yield in: query required: false description: Maximum yield to maturity filter. schema: type: number - name: currency in: query required: false description: Filter by currency (e.g., 'USD', 'EUR'). schema: type: string - name: offset in: query required: false description: Pagination offset. schema: type: integer default: 0 - name: limit in: query required: false description: Maximum results to return. schema: type: integer default: 50 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bond list. content: application/json: schema: type: object properties: total: type: integer description: Total matching bonds. offset: type: integer limit: type: integer bonds: type: array items: type: object properties: isin: type: string name: type: string risk_score: type: number risk_category: type: string yield_to_maturity: type: number coupon_rate: type: number maturity_date: type: string format: date currency: type: string credit_rating: type: string '401': description: Unauthorized. Invalid API token. tags: - Investment Analytics /mp/praams/explore/equity: get: summary: Explore equities description: Search and filter equities using PRAAMS analytics. Returns a list of equities matching the specified criteria with risk scores. operationId: ExplorePRAAMSEquities parameters: - name: risk_category in: query required: false description: Filter by risk category (e.g., 'Low', 'Medium', 'High'). schema: type: string - name: sector in: query required: false description: Filter by sector. schema: type: string - name: country in: query required: false description: Filter by country code. schema: type: string - name: min_market_cap in: query required: false description: Minimum market capitalization filter. schema: type: number - name: offset in: query required: false description: Pagination offset. schema: type: integer default: 0 - name: limit in: query required: false description: Maximum results to return. schema: type: integer default: 50 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved equity list. content: application/json: schema: type: object properties: total: type: integer description: Total matching equities. offset: type: integer limit: type: integer equities: type: array items: type: object properties: ticker: type: string isin: type: string name: type: string risk_score: type: number risk_category: type: string sector: type: string country: type: string market_cap: type: number beta: type: number '401': description: Unauthorized. Invalid API token. tags: - Investment Analytics /mp/praams/reports/bond/{isin}: get: summary: Get bond report by ISIN description: Returns a comprehensive PRAAMS report for a specific bond, including risk assessment and analytics. operationId: GetPRAAMSBondReport parameters: - name: isin in: path required: true description: Bond ISIN code. schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bond report. content: application/json: schema: type: object properties: isin: type: string name: type: string report_date: type: string format: date risk_summary: type: object properties: risk_score: type: number risk_category: type: string credit_risk: type: string interest_rate_risk: type: string bond_details: type: object properties: coupon_rate: type: number maturity_date: type: string format: date yield_to_maturity: type: number duration: type: number convexity: type: number issuer: type: string credit_rating: type: string '401': description: Unauthorized. Invalid API token. '404': description: Bond not found. tags: - Investment Analytics /mp/praams/reports/equity/isin/{isin}: get: summary: Get equity report by ISIN description: Returns a comprehensive PRAAMS report for a specific equity identified by ISIN. operationId: GetPRAAMSEquityReportByISIN parameters: - name: isin in: path required: true description: Equity ISIN code. schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved equity report. content: application/json: schema: type: object properties: isin: type: string name: type: string report_date: type: string format: date risk_summary: type: object properties: risk_score: type: number risk_category: type: string volatility_risk: type: string market_risk: type: string equity_details: type: object properties: sector: type: string market_cap: type: number beta: type: number pe_ratio: type: number dividend_yield: type: number performance: type: object properties: return_1y: type: number return_3y: type: number sharpe_ratio: type: number max_drawdown: type: number '401': description: Unauthorized. Invalid API token. '404': description: Equity not found. tags: - Investment Analytics /mp/praams/reports/equity/ticker/{ticker}: get: summary: Get equity report by ticker description: Returns a comprehensive PRAAMS report for a specific equity, including risk assessment and analytics. operationId: GetPRAAMSEquityReportByTicker parameters: - name: ticker in: path required: true description: Ticker symbol (e.g., 'AAPL.US'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved equity report. content: application/json: schema: type: object properties: ticker: type: string name: type: string report_date: type: string format: date risk_summary: type: object properties: risk_score: type: number risk_category: type: string volatility_risk: type: string market_risk: type: string equity_details: type: object properties: sector: type: string market_cap: type: number beta: type: number pe_ratio: type: number dividend_yield: type: number performance: type: object properties: return_1y: type: number return_3y: type: number sharpe_ratio: type: number max_drawdown: type: number '401': description: Unauthorized. Invalid API token. '404': description: Equity not found. tags: - Investment Analytics /mp/unicornbay/options/contracts: get: summary: Get options contracts description: Fetch options contracts filtered by underlying symbol, expiration, strike, type, or contract name. Supports sorting, pagination, and field selection. operationId: getOptionsContracts parameters: - name: filter[contract] in: query schema: type: string description: Exact contract name, e.g., AAPL270115P00450000 - name: filter[underlying_symbol] in: query schema: type: string description: Underlying symbol, e.g., AAPL - name: filter[exp_date_eq] in: query schema: type: string description: Expiration equals (YYYY-MM-DD) - name: filter[exp_date_from] in: query schema: type: string description: Expiration from (YYYY-MM-DD) - name: filter[exp_date_to] in: query schema: type: string description: Expiration to (YYYY-MM-DD) - name: filter[tradetime_eq] in: query schema: type: string description: Trade time equals (YYYY-MM-DD) - name: filter[tradetime_from] in: query schema: type: string description: Trade time from (YYYY-MM-DD) - name: filter[tradetime_to] in: query schema: type: string description: Trade time to (YYYY-MM-DD) - name: filter[type] in: query schema: type: string enum: - put - call description: Option type - name: filter[strike_eq] in: query schema: type: number description: Strike equals - name: filter[strike_from] in: query schema: type: number description: Strike from - name: filter[strike_to] in: query schema: type: number description: Strike to - name: sort in: query schema: type: string enum: - exp_date - strike - -exp_date - -strike description: Sort by expiration date or strike (asc/desc). - name: page[offset] in: query schema: type: integer minimum: 0 maximum: 10000 default: 0 description: Pagination offset (records to skip). Max 10000. - name: page[limit] in: query schema: type: integer minimum: 1 maximum: 1000 default: 1000 description: Pagination limit. Default & max 1000. - name: fields[options-contracts] in: query schema: type: string description: CSV of fields to include (e.g., contract,exp_date,strike). - name: fmt in: query schema: type: string enum: - json - xml default: json description: Response format. responses: '200': description: Contracts list. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object required: - id - type - attributes properties: id: type: string type: type: string const: options-contracts attributes: type: object description: Common fields for options contract/EOD records. Values may be null. properties: contract: type: string underlying_symbol: type: string exp_date: type: string description: YYYY-MM-DD expiration_type: type: - string - 'null' type: type: string enum: - call - put strike: type: - number - 'null' exchange: type: - string - 'null' currency: type: - string - 'null' open: type: - number - 'null' high: type: - number - 'null' low: type: - number - 'null' last: type: - number - 'null' last_size: type: - integer - 'null' change: type: - number - 'null' pctchange: type: - number - 'null' previous: type: - number - 'null' previous_date: type: - string - 'null' bid: type: - number - 'null' bid_date: type: - string - 'null' bid_size: type: - integer - 'null' ask: type: - number - 'null' ask_date: type: - string - 'null' ask_size: type: - integer - 'null' moneyness: type: - number - 'null' volume: type: - integer - 'null' volume_change: type: - integer - 'null' volume_pctchange: type: - number - 'null' open_interest: type: - integer - 'null' open_interest_change: type: - integer - 'null' open_interest_pctchange: type: - number - 'null' volatility: type: - number - 'null' volatility_change: type: - number - 'null' volatility_pctchange: type: - number - 'null' theoretical: type: - number - 'null' delta: type: - number - 'null' gamma: type: - number - 'null' theta: type: - number - 'null' vega: type: - number - 'null' rho: type: - number - 'null' tradetime: type: - string - 'null' description: YYYY-MM-DD (last trade or last market update; see docs) vol_oi_ratio: type: - number - 'null' dte: type: - integer - 'null' description: Days to expiration midpoint: type: - number - 'null' additionalProperties: false additionalProperties: false links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false examples: sample: summary: AAPL, 5 newest expirations value: meta: offset: 0 limit: 5 total: 14394 fields: - contract - underlying_symbol - exp_date - expiration_type - type - strike - exchange - currency - open - high - low - last - last_size - change - pctchange - previous - previous_date - bid - bid_date - bid_size - ask - ask_date - ask_size - moneyness - volume - volume_change - volume_pctchange - open_interest - open_interest_change - open_interest_pctchange - volatility - volatility_change - volatility_pctchange - theoretical - delta - gamma - theta - vega - rho - tradetime - vol_oi_ratio - dte - midpoint data: - id: AAPL271217C00420000 type: options-contracts attributes: contract: AAPL271217C00420000 underlying_symbol: AAPL exp_date: '2027-12-17' expiration_type: monthly type: call strike: 420 exchange: NASDAQ currency: USD open: 3.35 high: 3.35 low: 3.29 last: 3.29 last_size: 1 change: 0.09 pctchange: 2.81 previous: 3.2 previous_date: '2025-08-11' bid: 2.85 bid_date: '2025-08-12 20:00:00' bid_size: 58 ask: 4.4 ask_date: '2025-08-12 20:00:00' ask_size: 173 moneyness: -0.83 volume: 4 volume_change: -5 volume_pctchange: -55.56 open_interest: 299 open_interest_change: 7 open_interest_pctchange: 2.4 volatility: 0.2337 volatility_change: -0.0023 volatility_pctchange: -0.99 theoretical: 3.29 delta: 0.097466 gamma: 0.002088 theta: -0.00993 vega: 0.604392 rho: 0.448547 tradetime: '2025-08-12' vol_oi_ratio: 0.01 dte: 857 midpoint: 3.63 links: next: https://eodhd.com/api/mp/unicornbay/options/contracts?sort=-exp_date&filter[underlying_symbol]=AAPL&page[offset]=5&page[limit]=5 '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: Unprocessable Entity content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Options /mp/unicornbay/options/eod: get: summary: Get end-of-day options data description: Returns EOD trades/bid data for options, with the same filter set as contracts. Supports compact mode (`compact=1`) to return arrays instead of objects. operationId: getOptionsEOD parameters: - name: filter[contract] in: query schema: type: string description: Exact contract name, e.g., AAPL270115P00450000 - name: filter[underlying_symbol] in: query schema: type: string description: Underlying symbol, e.g., AAPL - name: filter[exp_date_eq] in: query schema: type: string description: Expiration equals (YYYY-MM-DD) - name: filter[exp_date_from] in: query schema: type: string description: Expiration from (YYYY-MM-DD) - name: filter[exp_date_to] in: query schema: type: string description: Expiration to (YYYY-MM-DD) - name: filter[tradetime_eq] in: query schema: type: string description: Trade time equals (YYYY-MM-DD) - name: filter[tradetime_from] in: query schema: type: string description: Trade time from (YYYY-MM-DD) - name: filter[tradetime_to] in: query schema: type: string description: Trade time to (YYYY-MM-DD) - name: filter[type] in: query schema: type: string enum: - put - call description: Option type - name: filter[strike_eq] in: query schema: type: number description: Strike equals - name: filter[strike_from] in: query schema: type: number description: Strike from - name: filter[strike_to] in: query schema: type: number description: Strike to - name: sort in: query schema: type: string enum: - exp_date - strike - -exp_date - -strike description: Sort by expiration date or strike (asc/desc). - name: page[offset] in: query schema: type: integer minimum: 0 maximum: 10000 default: 0 description: Pagination offset (records to skip). Max 10000. - name: page[limit] in: query schema: type: integer minimum: 1 maximum: 1000 default: 1000 description: Pagination limit. Default & max 1000. - name: fields[options-eod] in: query schema: type: string description: CSV of fields to include (e.g., contract,exp_date,strike). - name: compact in: query schema: type: integer enum: - 0 - 1 default: 0 description: Set 1 for compact mode (rows as arrays in `data`, columns = `meta.fields`). - name: fmt in: query schema: type: string enum: - json - xml default: json description: Response format. responses: '200': description: EOD options data (standard or compact). content: application/json: schema: oneOf: - type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object required: - id - type - attributes properties: id: type: string type: type: string const: options-eod attributes: type: object description: Common fields for options contract/EOD records. Values may be null. properties: contract: type: string underlying_symbol: type: string exp_date: type: string description: YYYY-MM-DD expiration_type: type: - string - 'null' type: type: string enum: - call - put strike: type: - number - 'null' exchange: type: - string - 'null' currency: type: - string - 'null' open: type: - number - 'null' high: type: - number - 'null' low: type: - number - 'null' last: type: - number - 'null' last_size: type: - integer - 'null' change: type: - number - 'null' pctchange: type: - number - 'null' previous: type: - number - 'null' previous_date: type: - string - 'null' bid: type: - number - 'null' bid_date: type: - string - 'null' bid_size: type: - integer - 'null' ask: type: - number - 'null' ask_date: type: - string - 'null' ask_size: type: - integer - 'null' moneyness: type: - number - 'null' volume: type: - integer - 'null' volume_change: type: - integer - 'null' volume_pctchange: type: - number - 'null' open_interest: type: - integer - 'null' open_interest_change: type: - integer - 'null' open_interest_pctchange: type: - number - 'null' volatility: type: - number - 'null' volatility_change: type: - number - 'null' volatility_pctchange: type: - number - 'null' theoretical: type: - number - 'null' delta: type: - number - 'null' gamma: type: - number - 'null' theta: type: - number - 'null' vega: type: - number - 'null' rho: type: - number - 'null' tradetime: type: - string - 'null' description: YYYY-MM-DD (last trade or last market update; see docs) vol_oi_ratio: type: - number - 'null' dte: type: - integer - 'null' description: Days to expiration midpoint: type: - number - 'null' additionalProperties: false additionalProperties: false links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false - type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: array items: type: - string - number - integer - 'null' description: Row aligned to columns listed in meta.fields. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false examples: standard: summary: Standard JSON (objects) value: meta: offset: 0 limit: 5 total: 227 fields: - contract - underlying_symbol - exp_date - expiration_type - type - strike - exchange - currency - open - high - low - last - last_size - change - pctchange - previous - previous_date - bid - bid_date - bid_size - ask - ask_date - ask_size - moneyness - volume - volume_change - volume_pctchange - open_interest - open_interest_change - open_interest_pctchange - volatility - volatility_change - volatility_pctchange - theoretical - delta - gamma - theta - vega - rho - tradetime - vol_oi_ratio - dte - midpoint data: - id: AAPL270115P00450000-2025-08-12 type: options-eod attributes: contract: AAPL270115P00450000 underlying_symbol: AAPL exp_date: '2027-01-15' expiration_type: monthly type: put strike: 450 exchange: NASDAQ currency: USD open: 0 high: 0 low: 0 last: 245.9 last_size: 0 change: 0 pctchange: 0 previous: 0 previous_date: '' bid: 218.4 bid_date: '2025-08-12 19:59:59' bid_size: 115 ask: 222.2 ask_date: '2025-08-12 19:59:59' ask_size: 17 moneyness: 0.96 volume: 0 volume_change: 0 volume_pctchange: 0 open_interest: 0 open_interest_change: 0 open_interest_pctchange: 0 volatility: 0.4863 volatility_change: 0 volatility_pctchange: 0 theoretical: 222.2 delta: -0.877218 gamma: 0.001594 theta: -0.012408 vega: 0.482281 rho: -1.0 tradetime: '2025-06-08' vol_oi_ratio: 0 dte: 521 midpoint: 220.3 links: next: https://eodhd.com/api/mp/unicornbay/options/eod?sort=-exp_date&filter[contract]=AAPL270115P00450000&page[offset]=5&page[limit]=5 '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: Unprocessable Entity content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Options /mp/unicornbay/options/underlying-symbols: get: summary: List underlying symbols with options description: Returns the list of all supported stock symbols for which option contracts are available. May be paginated. operationId: listUnderlyingSymbols parameters: - name: page[offset] in: query schema: type: integer minimum: 0 maximum: 10000 default: 0 description: Pagination offset (records to skip). - name: page[limit] in: query schema: type: integer minimum: 1 maximum: 1000 default: 1000 description: Pagination limit. Default & max 1000. - name: fmt in: query schema: type: string enum: - json - xml default: json description: Response format. responses: '200': description: Supported underlying symbols. content: application/json: schema: type: object required: - meta - data properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: string links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false examples: sample: summary: First page (truncated) value: meta: total: 5972 fields: - underlying_symbol compact: true data: - A - AA - AAAU - AACT - AADI - AAL - AAMI - AAN - AAOI - AAON - AAP - AAPL links: next: '' '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: Unprocessable Entity content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Options /mp/unicornbay/spglobal/comp/{symbol}: get: summary: Index components (current + historical) description: Returns the current components and historical changes for an index symbol. operationId: getIndexComponents parameters: - name: symbol in: path required: true description: Index symbol, e.g., GSPC.INDX schema: type: string - name: fmt in: query required: false description: Response format. schema: type: string enum: - json - xml default: json responses: '200': description: Successful response with index general info, components, and historical membership. content: application/json: schema: type: object required: - General - Components - HistoricalTickerComponents properties: General: type: object required: - Code - Type - Name - Exchange properties: Code: type: string Type: type: string Name: type: string Exchange: type: string MarketCap: type: - number - 'null' CurrencyCode: type: - string - 'null' CurrencyName: type: - string - 'null' CurrencySymbol: type: - string - 'null' CountryName: type: - string - 'null' CountryISO: type: - string - 'null' OpenFigi: type: - string - 'null' additionalProperties: false Components: type: object additionalProperties: type: object required: - Code - Exchange - Name properties: Code: type: string Exchange: type: string Name: type: string Sector: type: - string - 'null' Industry: type: - string - 'null' Weight: type: - number - 'null' additionalProperties: false properties: {} HistoricalTickerComponents: type: object additionalProperties: type: object required: - Code - Name - StartDate - IsActiveNow - IsDelisted properties: Code: type: string Name: type: string StartDate: type: string description: YYYY-MM-DD EndDate: type: - string - 'null' description: YYYY-MM-DD or null IsActiveNow: type: integer enum: - 0 - 1 IsDelisted: type: integer enum: - 0 - 1 additionalProperties: false properties: {} additionalProperties: false examples: sample: summary: GSPC.INDX (truncated) value: General: Code: GSPC Type: INDEX Name: S&P 500 Index Exchange: INDX MarketCap: 54158326748416.56 CurrencyCode: USD CurrencyName: US Dollar CurrencySymbol: $ CountryName: USA CountryISO: US OpenFigi: BBG000H4FSM0 Components: '0': Code: AAPL Exchange: US Name: Apple Inc Sector: Technology Industry: Consumer Electronics Weight: 0.0628 HistoricalTickerComponents: '0': Code: AAPL Name: Apple Inc StartDate: '1982-11-30' EndDate: '' IsActiveNow: 1 IsDelisted: 0 '401': description: Unauthorized content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Indices /mp/unicornbay/spglobal/list: get: summary: List of indices with details description: Returns essential EOD details for 100+ S&P & Dow Jones indices. operationId: listIndicesWithDetails parameters: - name: fmt in: query required: false description: Response format. schema: type: string enum: - json - xml default: json responses: '200': description: Successful response with an array of indices. content: application/json: schema: type: array items: type: object required: - ID - Code - Name - Constituents - LastUpdate properties: ID: type: string Code: type: string Name: type: string Constituents: type: integer LastUpdate: type: string description: YYYY-MM-DD Value: type: - number - 'null' MarketCap: type: - number - 'null' Divisor: type: - number - 'null' DailyReturn: type: - number - string - 'null' Dividend: type: - number - 'null' AdjustedMarketCap: type: - number - 'null' AdjustedDivisor: type: - number - 'null' AdjustedConstituents: type: - integer - 'null' CurrencyCode: type: - string - 'null' CurrencyName: type: - string - 'null' CurrencySymbol: type: - string - 'null' additionalProperties: false examples: sample: summary: Truncated list value: - ID: SP1000.INDX Code: SP1000 Name: S&P 1000 Constituents: 1003 Value: 17205.7704 MarketCap: 4276250432997.9194 Divisor: 248535830.1502 DailyReturn: 0.0007 Dividend: 0.1364 AdjustedMarketCap: 4276250432997.9194 AdjustedDivisor: 248535830.1502 AdjustedConstituents: 1003 CurrencyCode: USD CurrencyName: US Dollar CurrencySymbol: $ LastUpdate: '2025-08-08' '401': description: Unauthorized content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: text/html: schema: type: string application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Indices /mp/unicornbay/tickdata/ticks: get: summary: Retrieve marketplace tick data description: Get tick-level data via the UnicornBay marketplace data provider. Returns granular trade-by-trade data for supported symbols. operationId: GetMarketplaceTickData parameters: - name: s in: query required: true description: Ticker symbol (e.g., 'AAPL' or 'AAPL.US'). schema: type: string - name: from in: query required: false description: Start UNIX timestamp (UTC). schema: type: integer format: int64 - name: to in: query required: false description: End UNIX timestamp (UTC). schema: type: integer format: int64 - name: limit in: query required: false description: Maximum number of ticks to return. schema: type: integer - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved tick data. content: application/json: schema: type: array items: type: object properties: timestamp: type: integer format: int64 description: Trade timestamp in milliseconds since epoch. price: type: number description: Trade price. volume: type: integer description: Number of shares traded. exchange: type: string description: Exchange code where trade occurred. conditions: type: string description: Trade condition codes. '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Tick data not found. tags: - Tick Data /news: get: summary: Retrieve financial news articles description: Retrieve financial news articles for a specific company ticker or topic operationId: GetFinancialNews parameters: - name: s in: query required: false description: Ticker code to get news for (e.g., 'AAPL.US'). Required if 't' is not provided. schema: type: string - name: t in: query required: false description: Tag to get news on a given topic. Required if 's' is not provided. schema: type: string - name: from in: query required: false description: Start date for news data (YYYY-MM-DD) schema: type: string format: date - name: to in: query required: false description: End date for news data (YYYY-MM-DD) schema: type: string format: date - name: limit in: query required: false description: The number of results to return schema: type: integer default: 50 minimum: 1 maximum: 1000 - name: offset in: query required: false description: The offset of the data schema: type: integer default: 0 minimum: 0 - name: fmt in: query required: false description: Response format (e.g., 'json') schema: type: string enum: - json responses: '200': description: Successful response with financial news articles content: application/json: schema: type: array items: type: object properties: date: type: string format: date-time title: type: string content: type: string link: type: string format: uri symbols: type: array items: type: string tags: type: array items: type: string sentiment: type: object properties: polarity: type: number neg: type: number neu: type: number pos: type: number example: - date: '2024-06-05T20:35:00+00:00' title: Usher and Apple CEO Tim Cook had a meeting... content: Usher has some suggestions for Apple CEO Tim Cook... link: https://finance.yahoo.com/news/usher-apple-ceo-tim-cook-203500033.html symbols: - AAPL.US tags: [] sentiment: polarity: 0.997 neg: 0.024 neu: 0.871 pos: 0.105 - date: '2024-06-05T20:33:57+00:00' title: 'The 2030''s Millionaire Club: 3 Hyper-Growth Stocks to Buy Now' content: Hyper-growth stocks offer excitement... link: https://finance.yahoo.com/news/2030-millionaire-club-3-hyper-203357155.html symbols: - AAPL.US - NVDA.US - PLTR.US tags: [] sentiment: polarity: 1 neg: 0.018 neu: 0.781 pos: 0.202 '400': description: Invalid request parameters '401': description: Unauthorized '404': description: No news articles found tags: - News /news-word-weights: get: summary: Top weighted news keywords for a ticker description: Returns the most relevant words from financial news for the given ticker and period, with weights (frequency ? significance). operationId: getNewsWordWeights parameters: - name: s in: query required: true description: Ticker to analyze, e.g., AAPL or AAPL.US schema: type: string - name: filter[date_from] in: query required: false description: Start date (YYYY-MM-DD) schema: type: string format: date - name: filter[date_to] in: query required: false description: End date (YYYY-MM-DD). Prefer this over the legacy alias `filter[to]`. schema: type: string format: date - name: filter[to] in: query required: false deprecated: true description: Deprecated alias for `filter[date_to]` (YYYY-MM-DD). Use only one of these parameters. schema: type: string format: date - name: page[limit] in: query required: false description: Number of top words to return schema: type: integer minimum: 1 maximum: 500 default: 10 - name: fmt in: query required: false description: Response format schema: type: string enum: - json - xml default: json responses: '200': description: Weighted keywords for the requested period content: application/json: schema: type: object required: - data - meta - links properties: data: type: object description: Map of keyword â weight additionalProperties: type: number meta: type: object required: - news_found - news_processed properties: news_found: type: integer minimum: 0 news_processed: type: integer minimum: 0 additionalProperties: false links: type: object required: - next properties: next: type: - string - 'null' description: URL for the next page, or null additionalProperties: false additionalProperties: false examples: sample: summary: AAPL example (2025-04-08 > 2025-04-16, top-10) value: data: appl: 0.01922 tariff: 0.01889 stock: 0.01884 trump: 0.01115 companies: 0.00983 market: 0.00919 china: 0.0079 trade: 0.00723 ai: 0.00605 price: 0.00577 meta: news_processed: 300 news_found: 5748 links: next: '' '400': description: Invalid request parameters content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: No results found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too many requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '500': description: Server error content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - News /rates/reference-rates: get: summary: Get reference interest rates description: Returns benchmark reference interest rates (e.g., SOFR, SONIA, ESTR) by code and currency. operationId: GetReferenceRates parameters: - name: filter[code] in: query required: false description: Filter by reference rate code (e.g., 'SOFR'). schema: type: string - name: filter[currency] in: query required: false description: Filter by currency. schema: type: string enum: - USD - GBP - EUR - name: filter[from] in: query required: false description: Start date (YYYY-MM-DD). schema: type: string format: date - name: filter[to] in: query required: false description: End date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved reference rates. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: date: type: string format: date description: Observation date. code: type: string description: Reference rate code. currency: type: string description: Currency of the rate. rate_type: type: string description: Type of rate. rate: type: number description: Rate value. source: type: string description: Data source. source_series_id: type: string description: Source series identifier. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Interest Rates /rates/policy-rates: get: summary: Get central bank policy rates description: Returns central bank policy (target) interest rates by code, country, and central bank. operationId: GetPolicyRates parameters: - name: filter[code] in: query required: false description: Filter by policy rate code. schema: type: string - name: filter[country] in: query required: false description: Filter by country. schema: type: string - name: filter[central_bank] in: query required: false description: Filter by central bank (e.g., 'FED', 'ECB'). schema: type: string - name: filter[from] in: query required: false description: Start date (YYYY-MM-DD). schema: type: string format: date - name: filter[to] in: query required: false description: End date (YYYY-MM-DD). schema: type: string format: date - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved policy rates. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: date: type: string format: date description: Observation date. code: type: string description: Policy rate code. country: type: string description: Country. central_bank: type: string description: Central bank. rate: type: number description: Policy rate value. source: type: string description: Data source. source_series_id: type: string description: Source series identifier. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Interest Rates /real-time/{ticker}: get: summary: Retrieve delayed real-time stock prices description: Retrieve live (delayed) stock prices for specified ticker(s). operationId: GetLiveDelayedStockPrices parameters: - name: ticker in: path required: true description: Ticker symbol with exchange code (e.g., 'AAPL.US'). schema: type: string - name: s in: query required: false description: Comma-separated list of additional ticker symbols for multiple requests in a single call (e.g., 'VTI,EUR.FOREX'). schema: type: string - name: ex in: query required: false description: Exchange code filter (e.g., 'US'). schema: type: string - name: fmt in: query required: false description: Response format. Options are 'json' and 'csv'. Defaults to JSON. schema: type: string enum: - json - csv responses: '200': description: Successful response with live (delayed) stock prices. content: application/json: schema: oneOf: - type: object properties: code: type: string timestamp: type: integer gmtoffset: type: integer open: type: number high: type: number low: type: number close: type: number volume: type: - integer - 'null' previousClose: type: number change: type: number change_p: type: number - type: array items: type: object properties: code: type: string timestamp: type: integer gmtoffset: type: integer open: type: number high: type: number low: type: number close: type: number volume: type: - integer - 'null' previousClose: type: number change: type: number change_p: type: number examples: singleTicker: summary: Single ticker response value: code: AAPL.US timestamp: 1729888080 gmtoffset: 0 open: 229.74 high: 233.22 low: 229.57 close: 231.41 volume: 37931706 previousClose: 230.57 change: 0.84 change_p: 0.3643 multipleTickers: summary: Multiple tickers response value: - code: AAPL.US timestamp: 1729888080 gmtoffset: 0 open: 229.74 high: 233.22 low: 229.57 close: 231.41 volume: 37931706 previousClose: 230.57 change: 0.84 change_p: 0.3643 - code: VTI.US timestamp: 1729887240 gmtoffset: 0 open: 287.03 high: 288.25 low: 285.05 close: 285.54 volume: 2811137 previousClose: 285.81 change: -0.27 change_p: -0.0945 - code: EUR.FOREX timestamp: 1729891800 gmtoffset: 0 open: 0.9232 high: 0.9263 low: 0.9223 close: 0.9257 volume: 0 previousClose: 0.9262 change: -0.0005 change_p: -0.054 '400': description: Invalid request parameters. '401': description: Unauthorized. '404': description: Ticker not found. tags: - Live (Delayed) Data /sanctions/entities: get: summary: Get sanctioned entities description: Returns sanctioned entities (individuals and organizations) aggregated from OFAC and other sanctions sources, including programs, aliases, and identifiers. operationId: GetSanctionsEntities parameters: - name: source in: query required: false description: Filter by sanctions source. schema: type: string enum: - ofac - name: type in: query required: false description: Filter by entity type. schema: type: string enum: - individual - entity - vessel - aircraft - name: program in: query required: false description: Filter by sanctions program code. schema: type: string - name: country in: query required: false description: Filter by country. schema: type: string - name: q in: query required: false description: Free-text search query (minimum 2 characters). schema: type: string minLength: 2 - name: active in: query required: false description: Filter by active listing status. schema: type: string enum: - 'true' - 'false' - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved sanctioned entities. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: id: type: integer description: Unique identifier of the record. source: type: string description: Sanctions data source (e.g., 'OFAC'). source_uid: type: string description: Unique identifier of the entity within the source. entity_type: type: string description: Type of entity (e.g., individual, entity, vessel). name: type: string description: Primary name of the sanctioned entity. programs: type: array description: Sanctions program codes the entity is listed under. items: type: string country: type: - string - 'null' description: Associated country. remarks: type: - string - 'null' description: Free-text remarks from the source listing. listed_date: type: - string - 'null' description: Date the entity was listed. is_active: type: boolean description: Whether the listing is currently active. aliases: type: array description: Known aliases for the entity. items: type: string identifiers: type: array description: Identification documents or numbers associated with the entity. items: type: object additionalProperties: true links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Sanctions /sanctions/vessels: get: summary: Get sanctioned vessels description: Returns sanctioned vessels aggregated from OFAC and other sanctions sources, including IMO/MMSI identifiers, flag, and linked sanctioned entity. operationId: GetSanctionsVessels parameters: - name: source in: query required: false description: Filter by sanctions source. schema: type: string enum: - ofac - name: imo in: query required: false description: Filter by IMO number. schema: type: string - name: flag in: query required: false description: Filter by flag (country of registration). schema: type: string - name: vessel_type in: query required: false description: Filter by vessel type. schema: type: string - name: q in: query required: false description: Free-text search query (minimum 2 characters). schema: type: string minLength: 2 - name: program in: query required: false description: Filter by sanctions program code. schema: type: string - name: page[offset] in: query required: false description: Pagination offset (records to skip). schema: type: integer minimum: 0 default: 0 - name: page[limit] in: query required: false description: Number of records per page. Default 20, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 20 - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved sanctioned vessels. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: id: type: integer description: Unique identifier of the record. call_sign: type: - string - 'null' description: Vessel call sign. vessel_type: type: - string - 'null' description: Type of vessel. flag: type: - string - 'null' description: Flag (country of registration). tonnage: type: - number - 'null' description: Vessel tonnage. gross_tonnage: type: - number - 'null' description: Gross registered tonnage. owner: type: - string - 'null' description: Vessel owner. imo_number: type: - string - 'null' description: IMO number. mmsi: type: - string - 'null' description: Maritime Mobile Service Identity. entity_source_uid: type: string description: Source UID of the linked sanctioned entity. entity_name: type: string description: Name of the linked sanctioned entity. source: type: string description: Sanctions data source (e.g., 'OFAC'). programs: type: array description: Sanctions program codes the vessel is listed under. items: type: string country: type: string description: Associated country. is_active: type: boolean description: Whether the listing is currently active. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Sanctions /sanctions/programs: get: summary: Get sanctions programs description: Returns the list of sanctions programs with the count of listed entities per program. operationId: GetSanctionsPrograms parameters: - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved sanctions programs. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: program: type: string description: Sanctions program code. count: type: integer description: Number of entities listed under the program. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Sanctions /sanctions/sources: get: summary: Get sanctions sources description: Returns the list of sanctions data sources available in the dataset. operationId: GetSanctionsSources parameters: - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved sanctions sources. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: name: type: string description: Sanctions source name. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Sanctions /spreads/funding-stress: get: summary: Get funding-stress spreads description: Returns funding-stress spread series (in basis points) computed as the difference between two rate legs, with the underlying formula and leg values. operationId: GetFundingStressSpreads parameters: - name: filter[code] in: query required: false description: Filter by spread code (e.g., 'SOFR_OIS'). schema: type: string - name: filter[from] in: query required: false description: Start date (YYYY-MM-DD). schema: type: string format: date - name: filter[to] in: query required: false description: End date (YYYY-MM-DD). schema: type: string format: date - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved funding-stress spreads. content: application/json: schema: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: date: type: string format: date description: Observation date. code: type: string description: Spread code. value_bps: type: number description: Spread value in basis points. formula: type: string description: Formula used to compute the spread. leg_a: type: string description: First rate leg code. leg_b: type: string description: Second rate leg code. leg_a_rate: type: number description: Rate value of the first leg. leg_b_rate: type: number description: Rate value of the second leg. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false '401': description: Unauthorized content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '403': description: Forbidden content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '404': description: Not Found content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '422': description: 'Validation error. Returned when a parameter is malformed or a filter value is invalid. ' content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string '429': description: Too Many Requests content: application/json: schema: type: object properties: status: type: integer error: type: string message: type: string tags: - Interest Rates /screener: get: summary: Get filtered stock data based on user-defined criteria. description: Retrieves stock data filtered by criteria such as market capitalization, exchange, sector, and more. Results can be sorted and paginated. operationId: GetStockScreenerData parameters: - name: filters in: query required: false description: Filters to apply, structured as nested arrays (e.g., [["field", "operation", value], ...]). schema: type: string example: '[["market_capitalization",">",1000000000],["sector","=","Technology"]]' - name: signals in: query required: false description: Signals to filter tickers by pre-calculated fields (e.g., 200d_new_hi, bookvalue_pos). schema: type: string example: 200d_new_hi,bookvalue_pos - name: sort in: query required: false description: Sorts results by a specified field in ascending or descending order (e.g., market_capitalization.desc). schema: type: string example: market_capitalization.desc - name: limit in: query required: false description: Number of results per request. Minimum 1, maximum 500. Default is 50. schema: type: integer minimum: 1 maximum: 500 default: 50 - name: offset in: query required: false description: Data offset for paginating results. Minimum 0, maximum 999. Default is 0. schema: type: integer minimum: 0 maximum: 999 default: 0 responses: '200': description: Successful response with filtered stock data. content: application/json: schema: type: object properties: data: type: array items: type: object properties: code: type: string description: Ticker symbol. name: type: string description: Company name. last_day_data_date: type: string format: date description: Date of the latest data. adjusted_close: type: number description: Latest adjusted close price. refund_1d: type: number description: Refund value for the last day. refund_1d_p: type: number description: Refund percentage change for the last day. refund_5d: type: number description: Refund value for the last 5 days. refund_5d_p: type: number description: Refund percentage change for the last 5 days. exchange: type: string description: Exchange code. currency_symbol: type: string description: Currency symbol. market_capitalization: type: integer description: Market capitalization in USD. earnings_share: type: number description: Earnings per share (EPS). dividend_yield: type: number description: Dividend yield percentage. sector: type: string description: Company sector. industry: type: string description: Company industry. avgvol_1d: type: integer description: Average daily volume for the last day. avgvol_200d: type: number description: Average daily volume over the last 200 days. example: data: - code: AAPL name: Apple Inc last_day_data_date: '2024-10-25' adjusted_close: 231.41 refund_1d: 0.84 refund_1d_p: 0.36 refund_5d: -3.59 refund_5d_p: -1.53 exchange: US currency_symbol: $ market_capitalization: 3518380900352 earnings_share: 6.6 dividend_yield: 0.0043 sector: Technology industry: Consumer Electronics avgvol_1d: 38776700 avgvol_200d: 59597856 - code: NVDA name: NVIDIA Corporation last_day_data_date: '2024-10-25' adjusted_close: 141.54 refund_1d: 1.13 refund_1d_p: 0.8 refund_5d: 3.54 refund_5d_p: 2.57 exchange: US currency_symbol: $ market_capitalization: 3471975907328 earnings_share: 2.15 dividend_yield: 0.0003 sector: Technology industry: Semiconductors avgvol_1d: 205122109 avgvol_200d: 411629851.58 '400': description: Invalid request parameters. '401': description: Unauthorized. tags: - Screening /search/{query}: get: summary: Search stocks, companies, and ISINs description: Search for stocks, companies, or ISINs by a query (e.g., company name, stock symbol, or ISIN) operationId: SearchStocksByQuery parameters: - name: query in: path required: true description: The search query (e.g., 'AAPL', 'Amazon', or ISIN 'US3453708600') schema: type: string - name: fmt in: query required: false description: Response format (e.g., 'json') schema: type: string enum: - json - xml - name: limit in: query required: false description: Limit the number of results returned schema: type: integer example: 1 - name: type in: query required: false description: Filter by security type. schema: type: string enum: - all - stock - etf - fund - bond - index - crypto - name: exchange in: query required: false description: Filter by exchange code (e.g., 'US', 'LSE'). schema: type: string - name: bonds_only in: query required: false description: Set to 1 to return bonds only. schema: type: integer enum: - 0 - 1 responses: '200': description: Successful response with search results content: application/json: schema: type: array items: type: object properties: Code: type: string Exchange: type: string Name: type: string Type: type: string Country: type: string Currency: type: string ISIN: type: - string - 'null' previousClose: type: number previousCloseDate: type: string format: date example: - Code: AAPL Exchange: US Name: Apple Inc Type: Common Stock Country: USA Currency: USD ISIN: US0378331005 previousClose: 230.76 previousCloseDate: '2024-10-23' - Code: AMZN Exchange: US Name: Amazon.com Inc Type: Common Stock Country: USA Currency: USD ISIN: US0231351067 previousClose: 184.71 previousCloseDate: '2024-10-23' '400': description: Invalid request parameters '401': description: Unauthorized '404': description: No results found tags: - Screening /sentiments: get: summary: Retrieve market news sentiment data description: Retrieve sentiment analysis for financial news related to specified tickers. operationId: GetSentimentData parameters: - name: s in: query required: true description: Comma-separated list of ticker codes to retrieve sentiment data for (e.g., 'btc-usd.cc,aapl.us'). schema: type: string - name: from in: query required: false description: Start date for sentiment data (YYYY-MM-DD). schema: type: string format: date - name: to in: query required: false description: End date for sentiment data (YYYY-MM-DD). schema: type: string format: date - name: fmt in: query required: false description: Response format (only 'json' is supported). schema: type: string enum: - json responses: '200': description: Successful response with sentiment data by ticker. content: application/json: schema: type: object properties: ticker: type: object additionalProperties: type: array items: type: object properties: date: type: string format: date count: type: integer description: Number of articles or mentions analyzed for the given date. normalized: type: number minimum: -1 maximum: 1 description: Normalized sentiment score, where -1 represents a very negative sentiment, 0 is neutral, and 1 is very positive. required: - date - count - normalized example: ticker: BTC-USD.CC: - date: '2022-02-22' count: 8 normalized: -0.1811 - date: '2022-02-21' count: 5 normalized: 0.2824 AAPL.US: - date: '2022-02-22' count: 23 normalized: 0.6152 - date: '2022-02-21' count: 23 normalized: 0.3668 '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid or missing API token. '404': description: No sentiment data found for specified tickers or date range. tags: - News /splits/{ticker}: get: summary: Retrieve historical split data description: Fetches historical stock split data for a specified ticker, including split dates and ratios. operationId: GetHistoricalSplits parameters: - name: ticker in: path required: true description: Ticker symbol of the stock in the format {SYMBOL_NAME}.{EXCHANGE_ID} (e.g., 'AAPL.US' for NASDAQ or 'AAPL.MX' for the Mexican Stock Exchange). schema: type: string - name: from in: query required: false description: Start date for data retrieval in 'YYYY-MM-DD' format. Defaults to earliest available data if not provided. schema: type: string format: date - name: to in: query required: false description: End date for data retrieval in 'YYYY-MM-DD' format. Defaults to latest available data if not provided. schema: type: string format: date - name: fmt in: query required: false description: Output format, either 'json' or 'csv'. Defaults to 'json'. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved historical split data. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Date of the stock split. split: type: string description: Split ratio represented as '{new shares}/{old shares}' (e.g., '2.000000/1.000000'). required: - date - split example: - date: '2000-06-21' split: 2.000000/1.000000 - date: '2005-02-28' split: 2.000000/1.000000 - date: '2014-06-09' split: 7.000000/1.000000 - date: '2020-08-31' split: 4.000000/1.000000 '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Split data not found for the specified ticker or date range. tags: - Dividends & Splits /symbol-change-history: get: summary: Retrieve symbol change history description: Retrieve the symbol change history within a specified date range. Only US exchanges are currently supported. operationId: GetSymbolChangeHistory parameters: - name: from in: query required: true description: Start date for symbol change history in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: true description: End date for symbol change history in 'YYYY-MM-DD' format. schema: type: string format: date - name: ex in: query required: false description: Exchange code filter (e.g., 'US'). schema: type: string - name: fmt in: query required: false description: Response format. Options are 'json' and 'csv'. Defaults to JSON. schema: type: string enum: - json - csv responses: '200': description: Successful response with symbol change history. content: application/json: schema: type: array items: type: object properties: exchange: type: string old_symbol: type: string new_symbol: type: string company_name: type: string effective: type: string format: date example: - exchange: US old_symbol: CBTX new_symbol: STEL company_name: Stellar Bancorp, Inc. Common Stock effective: '2022-10-03' - exchange: US old_symbol: FFR new_symbol: DTRE company_name: First Trust Alerian Disruptive Technology Real Estate ETF effective: '2022-10-03' - exchange: US old_symbol: XPER new_symbol: ADEA company_name: Adeia Inc. Common Stock effective: '2022-10-03' - exchange: US old_symbol: CNTQ new_symbol: DFLI company_name: Dragonfly Energy Holdings Corp. Common Stock (NV) effective: '2022-10-10' - exchange: US old_symbol: CNTQW new_symbol: DFLIW company_name: Dragonfly Energy Holdings Corp. Warrant effective: '2022-10-10' - exchange: US old_symbol: LLL new_symbol: JXJT company_name: JX Luxventure Limited Common Stock effective: '2022-10-10' '400': description: Invalid request parameters. '401': description: Unauthorized. '404': description: No symbol change history found for the specified date range. tags: - Corporate Actions /technical/{ticker}: get: summary: Retrieve technical indicator data for a specified symbol. description: Fetches technical indicator data, such as moving averages and other analytics, based on specified parameters. operationId: GetTechnicalIndicatorData parameters: - name: ticker in: path required: true description: Symbol in the format {SYMBOL_NAME}.{EXCHANGE_ID}, e.g., AAPL.US for Apple Inc. schema: type: string - name: function in: query required: true description: The function to calculate the technical indicator (e.g., 'sma' for Simple Moving Average). schema: type: string enum: - sma - ema - wma - volatility - stochastic - rsi - stddev - stochrsi - slope - dmi - adx - macd - atr - cci - sar - beta - bbands - splitadjusted - avgvol - avgvolccy - name: period in: query required: false description: Number of data points used to calculate the indicator. Default is 50. schema: type: integer minimum: 2 maximum: 100000 default: 50 - name: from in: query required: false description: Start date for data retrieval in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date for data retrieval in 'YYYY-MM-DD' format. schema: type: string format: date - name: order in: query required: false description: 'Sort order of dates: ''a'' for ascending, ''d'' for descending. Default is ascending.' schema: type: string enum: - a - d default: a - name: fmt in: query required: false description: Output format, either 'json' or 'csv'. Default is 'json'. schema: type: string enum: - json - csv default: json - name: splitadjusted_only in: query required: false description: For select functions, adjust data only for splits by setting to '1'. Default is '0'. schema: type: integer enum: - 0 - 1 default: 0 - name: filter in: query required: false description: Retrieve only the last value by specifying 'last_ema' or 'last_volume' as the filter. schema: type: string responses: '200': description: Successful response with technical indicator data. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Date of the data point. sma: type: number description: Simple Moving Average value (specific to the chosen function). example: - date: '2020-12-31' sma: 118.4358 - date: '2020-12-30' sma: 118.1347 '400': description: Invalid request parameters. '401': description: Unauthorized. tags: - Technical /ticks: get: summary: Retrieve historical tick data description: Get historical stock tick data for US equities using UNIX time for filtering. Limited to US exchanges. operationId: GetTickData parameters: - name: s in: query required: true description: Ticker symbol (e.g., 'AAPL' or 'AAPL.US' for US-listed stocks). schema: type: string - name: from in: query required: false description: Start UNIX timestamp (UTC) for filtering data. schema: type: integer format: int64 - name: to in: query required: false description: End UNIX timestamp (UTC) for filtering data. schema: type: integer format: int64 - name: limit in: query required: false description: Maximum number of ticks to return. schema: type: integer - name: fmt in: query required: false description: Output format (only 'json' supported) schema: type: string enum: - json default: json responses: '200': description: Successful response with tick data content: application/json: schema: type: object properties: ex: type: array items: type: string description: List of exchanges where transactions took place. mkt: type: array items: type: string description: Market where trade took place. price: type: array items: type: number description: Price of the transaction. seq: type: array items: type: integer description: Trade sequence number. shares: type: array items: type: integer description: Number of shares in the transaction. sl: type: array items: type: string description: Sales condition codes for the trades. sub_mkt: type: array items: type: string description: Sub-market where trade took place. ts: type: array items: type: integer format: int64 description: Timestamp of each transaction in milliseconds since epoch. examples: default: summary: Tick data response example value: ex: - Q - Q - Q mkt: - K - K - K price: - 179.35 - 179.35 - 179.35 seq: - 64234 - 64238 - 64329 shares: - 50 - 10 - 100 sl: - '@ TI' - '@ TI' - '@ T' sub_mkt: - '' - '' - '' ts: - 1694419200008 - 1694419200008 - 1694419200008 '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Ticker data not found for the specified query. tags: - Tick Data /user: get: summary: Get current user details description: Returns details about the authenticated user, including subscription info and API usage. operationId: GetUserDetails parameters: - name: fmt in: query required: false description: Output format. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved user details. content: application/json: schema: type: object properties: name: type: string description: User name. email: type: string description: User email. subscriptionType: type: string description: Subscription plan type. paymentMethod: type: string description: Payment method. apiRequests: type: integer description: API requests used in current period. apiRequestsDate: type: string description: Date of last API request count reset. dailyRateLimit: type: integer description: Daily API request limit. '401': description: Unauthorized. Invalid API token. tags: - User /us-quote-delayed: get: summary: Get US delayed stock quotes description: Returns 15-minute delayed quote data for US equities. Supports multiple symbols in a single request. operationId: GetUSQuoteDelayed parameters: - name: s in: query required: true description: Comma-separated ticker symbols (e.g., 'AAPL,MSFT,GOOGL'). schema: type: string - name: fields in: query required: false description: Comma-separated list of fields to return (e.g., 'close,volume,change_p'). schema: type: string - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved delayed quote data. content: application/json: schema: type: array items: type: object properties: code: type: string description: Ticker symbol. timestamp: type: integer format: int64 description: UNIX timestamp of the quote. gmtoffset: type: integer description: GMT offset in seconds. open: type: number description: Opening price. high: type: number description: High price. low: type: number description: Low price. close: type: number description: Last traded price. volume: type: integer description: Trading volume. previousClose: type: number description: Previous day closing price. change: type: number description: Price change. change_p: type: number description: Percentage price change. '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. tags: - Live (Delayed) Data /ust/bill-rates: get: summary: Get US Treasury bill rates description: Returns daily US Treasury bill rates (discount rates for 4-week, 8-week, 13-week, 17-week, 26-week, and 52-week bills). operationId: GetUSTBillRates parameters: - name: from in: query required: false description: Start date in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date in 'YYYY-MM-DD' format. schema: type: string format: date - name: filter[year] in: query required: false description: Filter by year (e.g., 2024). schema: type: integer example: 2024 - name: page[limit] in: query required: false description: Number of records per page. schema: type: integer - name: page[offset] in: query required: false description: Pagination offset. schema: type: integer - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved Treasury bill rates. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Date of the rate. 4_weeks_bank_discount: type: number description: 4-week bill bank discount rate. 4_weeks_coupon_equivalent: type: number description: 4-week bill coupon equivalent yield. 8_weeks_bank_discount: type: number description: 8-week bill bank discount rate. 8_weeks_coupon_equivalent: type: number description: 8-week bill coupon equivalent yield. 13_weeks_bank_discount: type: number description: 13-week bill bank discount rate. 13_weeks_coupon_equivalent: type: number description: 13-week bill coupon equivalent yield. 26_weeks_bank_discount: type: number description: 26-week bill bank discount rate. 26_weeks_coupon_equivalent: type: number description: 26-week bill coupon equivalent yield. 52_weeks_bank_discount: type: number description: 52-week bill bank discount rate. 52_weeks_coupon_equivalent: type: number description: 52-week bill coupon equivalent yield. '401': description: Unauthorized. Invalid API token. '404': description: Data not found for specified date range. tags: - US Treasury /ust/long-term-rates: get: summary: Get US Treasury long-term rates description: Returns US Treasury long-term average rates and extrapolation factors for maturities beyond 30 years. operationId: GetUSTLongTermRates parameters: - name: from in: query required: false description: Start date in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date in 'YYYY-MM-DD' format. schema: type: string format: date - name: filter[year] in: query required: false description: Filter by year (e.g., 2024). schema: type: integer example: 2024 - name: page[limit] in: query required: false description: Number of records per page. schema: type: integer - name: page[offset] in: query required: false description: Pagination offset. schema: type: integer - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved long-term rates. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Date of the rate. lt_composite_gt_10: type: number description: Long-term composite rate (over 10 years). treasury_20_year_cmt: type: number description: Treasury 20-year constant maturity rate. extrapolation_factor: type: number description: Extrapolation factor. '401': description: Unauthorized. Invalid API token. '404': description: Data not found for specified date range. tags: - US Treasury /ust/real-yield-rates: get: summary: Get US Treasury real yield curve rates description: Returns daily US Treasury real yield curve rates (TIPS-derived real yields for 5-year, 7-year, 10-year, 20-year, and 30-year maturities). operationId: GetUSTRealYieldRates parameters: - name: from in: query required: false description: Start date in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date in 'YYYY-MM-DD' format. schema: type: string format: date - name: filter[year] in: query required: false description: Filter by year (e.g., 2024). schema: type: integer example: 2024 - name: page[limit] in: query required: false description: Number of records per page. schema: type: integer - name: page[offset] in: query required: false description: Pagination offset. schema: type: integer - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved real yield rates. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Date of the rate. 5_years: type: number description: 5-year real yield rate. 7_years: type: number description: 7-year real yield rate. 10_years: type: number description: 10-year real yield rate. 20_years: type: number description: 20-year real yield rate. 30_years: type: number description: 30-year real yield rate. '401': description: Unauthorized. Invalid API token. '404': description: Data not found for specified date range. tags: - US Treasury /ust/yield-rates: get: summary: Get US Treasury yield curve rates description: Returns daily US Treasury yield curve rates (constant maturity rates for 1-month through 30-year maturities). operationId: GetUSTYieldRates parameters: - name: from in: query required: false description: Start date in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date in 'YYYY-MM-DD' format. schema: type: string format: date - name: filter[year] in: query required: false description: Filter by year (e.g., 2024). schema: type: integer example: 2024 - name: page[limit] in: query required: false description: Number of records per page. schema: type: integer - name: page[offset] in: query required: false description: Pagination offset. schema: type: integer - name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json responses: '200': description: Successfully retrieved Treasury yield rates. content: application/json: schema: type: array items: type: object properties: date: type: string format: date description: Date of the rate. 1_month: type: number description: 1-month constant maturity rate. 2_months: type: number description: 2-month constant maturity rate. 3_months: type: number description: 3-month constant maturity rate. 4_months: type: number description: 4-month constant maturity rate. 6_months: type: number description: 6-month constant maturity rate. 1_year: type: number description: 1-year constant maturity rate. 2_years: type: number description: 2-year constant maturity rate. 3_years: type: number description: 3-year constant maturity rate. 5_years: type: number description: 5-year constant maturity rate. 7_years: type: number description: 7-year constant maturity rate. 10_years: type: number description: 10-year constant maturity rate. 20_years: type: number description: 20-year constant maturity rate. 30_years: type: number description: 30-year constant maturity rate. '401': description: Unauthorized. Invalid API token. '404': description: Data not found for specified date range. tags: - US Treasury /v1.1/bulk-fundamentals/{EXCHANGE}: get: summary: Retrieve bulk fundamental data for an exchange (v1.1) description: Fetches fundamental data in bulk for all symbols on a given exchange using API v1.1. Supports filtering by specific symbols and data sections (General, Highlights, Valuation, etc.). In v1.1, the fmt parameter only supports json format. operationId: GetBulkFundamentalsV1_1 parameters: - name: EXCHANGE in: path required: true description: Exchange code (e.g., 'US', 'LSE', 'TO'). schema: type: string - name: symbols in: query required: false description: Comma-separated list of symbols to filter (e.g., 'AAPL,MSFT,GOOGL'). schema: type: string - name: offset in: query required: false description: Offset for pagination (number of records to skip). schema: type: integer default: 0 - name: limit in: query required: false description: Maximum number of records to return (max 500). schema: type: integer default: 500 - name: version in: query required: false description: API version for response format. schema: type: integer - name: fmt in: query required: false description: Output format. In v1.1, only json format is supported. schema: type: string enum: - json default: json responses: '200': description: Successfully retrieved bulk fundamental data. content: application/json: schema: type: array items: type: object properties: General: type: object properties: Code: type: string Name: type: string Exchange: type: string Sector: type: string Industry: type: string Highlights: type: object properties: MarketCapitalization: type: number EBITDA: type: number PERatio: type: number Valuation: type: object properties: TrailingPE: type: number ForwardPE: type: number '400': description: Invalid request parameters. '401': description: Unauthorized. Invalid API token. '404': description: Exchange not found. tags: - Fundamentals /v1.1/fundamentals/{ticker}: get: summary: Retrieve filtered fundamental data for a specific symbol (v1.1) description: Fetches various sections of fundamental data for a given stock symbol using API v1.1. This version differs from v1 in the Earnings Trend section, which is split into Quarterly and Annual sub-objects with an additional "quarter" field on quarterly items. Use filters to specify the data section and sub-sections, such as Financials::Balance_Sheet::quarterly::2024-06-30 for quarterly Balance Sheet data. operationId: GetFundamentalDataV1_1 parameters: - name: ticker in: path required: true description: The ticker symbol in the format SYMBOL.EXCHANGE, e.g., 'AAPL.US' for Apple Inc. on NASDAQ. schema: type: string - name: filter in: query required: false description: Filter parameter to specify data section and optional sub-sections, e.g., `Financials::Balance_Sheet::quarterly::2024-06-30`. Supported sections include General, Highlights, Valuation, SharesStats, Technicals, SplitsDividends, AnalystRatings, Holders, InsiderTransactions, ESGScores, outstandingShares, Earnings, and Financials. When omitted, returns all sections. schema: type: string example: Financials::Income_Statement::annual::2023-12-31 - name: historical in: query required: false description: Set to 1 to return historical data for certain sections (e.g., outstandingShares). schema: type: integer enum: - 0 - 1 - name: from in: query required: false description: Start date for historical data in 'YYYY-MM-DD' format. schema: type: string format: date - name: to in: query required: false description: End date for historical data in 'YYYY-MM-DD' format. schema: type: string format: date - name: version in: query required: false description: API version for response format. schema: type: integer - name: no_cache in: query required: false description: Set to 1 to bypass cache and get fresh data. schema: type: integer enum: - 0 - 1 responses: '200': description: Successfully retrieved filtered fundamental data for the specified symbol and section. content: application/json: schema: type: object properties: General: type: object description: General company information properties: Code: type: string Name: type: string Exchange: type: string Sector: type: string Highlights: type: object description: Key financial highlights properties: MarketCapitalization: type: number EBITDA: type: number PERatio: type: number Valuation: type: object description: Company valuation metrics properties: TrailingPE: type: number ForwardPE: type: number EnterpriseValue: type: number SharesStats: type: object description: Shares statistics properties: SharesOutstanding: type: number SharesFloat: type: number PercentInstitutions: type: number Technicals: type: object description: Technical indicators properties: Beta: type: number 52WeekHigh: type: number 52WeekLow: type: number SplitsDividends: type: object description: Dividend and split information properties: DividendYield: type: number DividendDate: type: string format: date LastSplitFactor: type: string AnalystRatings: type: object description: Analyst ratings properties: Rating: type: number StrongBuy: type: integer Sell: type: integer Holders: type: object description: Institutional and fund holders properties: Institutions: type: array items: type: object properties: name: type: string totalShares: type: number Funds: type: array items: type: object properties: name: type: string totalShares: type: number InsiderTransactions: type: array description: Insider transactions items: type: object properties: date: type: string format: date ownerName: type: string transactionCode: type: string transactionAmount: type: number ESGScores: type: object description: Environmental, social, and governance scores properties: environmentScore: type: number socialScore: type: number governanceScore: type: number outstandingShares: type: object description: Outstanding shares data properties: annual: type: array items: type: object properties: date: type: string format: date shares: type: number quarterly: type: array items: type: object properties: date: type: string format: date shares: type: number Earnings: type: object description: Earnings data. In v1.1, Trend is split into Quarterly and Annual sub-objects. Quarterly items include a "quarter" field (Q1-Q4). properties: History: type: array items: type: object properties: date: type: string format: date epsActual: type: number Trend: type: object description: Earnings trend data split into Quarterly and Annual sub-objects. This is the key difference from v1 where Trend was a flat array. properties: Quarterly: type: array description: Quarterly earnings trend items with an additional quarter identifier. items: type: object properties: period: type: string quarter: type: string description: Fiscal quarter identifier. enum: - Q1 - Q2 - Q3 - Q4 epsEstimateAvg: type: number Annual: type: array description: Annual earnings trend items. items: type: object properties: period: type: string epsEstimateAvg: type: number Financials: type: object description: Financial statements properties: Balance_Sheet: type: object description: Balance sheet data properties: annual: type: array quarterly: type: array Income_Statement: type: object description: Income statement data properties: annual: type: array quarterly: type: array Cash_Flow: type: object description: Cash flow data properties: annual: type: array quarterly: type: array '400': description: Invalid request parameters or missing required filter. '401': description: Unauthorized. Invalid API token. '404': description: Data not found for the specified symbol or filter. tags: - Fundamentals /v2/exchange-details: get: summary: List available exchanges (v2) description: Returns an array of all exchange codes supported by the v2 endpoint. Use these codes to request details for a specific exchange via /v2/exchange-details/{code}. operationId: ListExchangeDetailsV2 responses: '200': description: Successful response with list of exchange codes. content: application/json: schema: type: object properties: data: type: array items: type: string description: Array of supported exchange codes. example: data: - ASEX - BMEX - BVMF - LSE - NEO - US - XAMS - XASX - XHKG - XKRX - XNSE - XPAR - XTKS '401': description: Unauthorized — missing or invalid API token. tags: - Exchanges /v2/exchange-details/{code}: get: summary: Get exchange details and trading hours (v2) description: Returns trading hours, extended sessions (pre-market, after-hours), lunch breaks, and the full holiday calendar for the requested exchange. Covers 73 exchanges with verified data. The code parameter is case-insensitive. operationId: GetExchangeDetailsV2 parameters: - name: code in: path required: true description: Exchange code (case-insensitive). Use /v2/exchange-details to get the list of supported codes. schema: type: string examples: us: summary: US exchanges (NYSE / NASDAQ) value: US hk: summary: Hong Kong Stock Exchange value: XHKG tokyo: summary: Tokyo Stock Exchange value: XTKS responses: '200': description: Successful response with exchange details, trading hours, and holiday calendar. content: application/json: schema: type: object properties: data: type: object properties: Name: type: string description: Full exchange name. Code: type: string description: Exchange code used in this endpoint. Timezone: type: string description: IANA timezone (e.g. America/New_York). TradingHours: type: object properties: Open: type: string description: Regular session open time (HH:MM:SS). Close: type: string description: Regular session close time (HH:MM:SS). WorkingDays: type: string description: Trading days (e.g. Mon, Tue, Wed, Thu, Fri). PreMarketOpen: type: string description: Pre-market session open (if available). PreMarketClose: type: string description: Pre-market session close (if available). AfterHoursOpen: type: string description: After-hours session open (if available). AfterHoursClose: type: string description: After-hours session close (if available). LunchBreakStart: type: string description: Lunch break start (if applicable). LunchBreakEnd: type: string description: Lunch break end (if applicable). required: - Open - Close - WorkingDays ExchangeHolidays: type: object description: Holiday calendar keyed by date (YYYY-MM-DD). additionalProperties: type: object properties: Holiday: type: string description: Holiday name. Type: type: string enum: - Official - Bank - EarlyClose description: Holiday type. EarlyClose: type: string description: Early close time (HH:MM:SS). Only present when Type is EarlyClose. required: - Holiday - Type required: - Name - Code - Timezone - TradingHours - ExchangeHolidays meta: type: array description: Reserved for future use. links: type: array description: Reserved for future use. example: data: Name: NYSE / NASDAQ Code: US Timezone: America/New_York TradingHours: Open: 09:30:00 Close: '16:00:00' WorkingDays: Mon, Tue, Wed, Thu, Fri PreMarketOpen: 04:00:00 PreMarketClose: 09:30:00 AfterHoursOpen: '16:00:00' AfterHoursClose: '20:00:00' ExchangeHolidays: '2026-01-01': Holiday: New Year's Day Type: Official '2026-01-19': Holiday: Martin Luther King Jr. Day Type: Official '2026-11-27': Holiday: Day after Thanksgiving Type: EarlyClose EarlyClose: '13:00:00' '2026-12-24': Holiday: Christmas Eve Type: EarlyClose EarlyClose: '13:00:00' '2026-12-25': Holiday: Christmas Day Type: Official meta: [] links: [] '401': description: Unauthorized — missing or invalid API token. '404': description: Exchange not found. tags: - Exchanges components: securitySchemes: EODHDQueryKey: type: apiKey in: query name: api_token description: EODHD API key (stored as a secret in ChatGPT). parameters: FmtCsvJson: name: fmt in: query required: false description: Output format. schema: type: string enum: - json - csv default: json FmtJsonXml: name: fmt in: query required: false description: Output format. schema: type: string enum: - json - xml default: json DateFrom: name: from in: query required: false description: Start date (YYYY-MM-DD). schema: type: string format: date DateTo: name: to in: query required: false description: End date (YYYY-MM-DD). schema: type: string format: date responses: UnauthorizedHtml: description: Unauthorized. content: text/html: schema: type: string ForbiddenHtml: description: Forbidden. content: text/html: schema: type: string NotFoundHtml: description: Not Found. content: text/html: schema: type: string TooManyHtml: description: Too Many Requests. content: text/html: schema: type: string headers: X-RateLimit-Limit: description: Requests per minute limit. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer Retry-After: description: Seconds to wait before retrying. schema: type: integer schemas: Error: type: object properties: status: type: integer error: type: string message: type: string InternalUser: type: object properties: name: type: string description: Full name of the user. email: type: string format: email description: Registered email address. subscriptionType: type: string enum: - monthly - yearly description: Type of subscription plan. paymentMethod: type: string description: Payment processor used for the subscription (e.g., Stripe, PayPal). apiRequests: type: integer description: Number of API requests in the current day. apiRequestsDate: type: string format: date description: Date of the current counter period (UTC). dailyRateLimit: type: integer description: Daily request limit for standard APIs. extraLimit: type: integer description: Extra daily limit granted (if any). inviteToken: type: - string - 'null' description: Referral invite token, if available. inviteTokenClicked: type: integer description: Clicks on the invite token link. subscriptionMode: type: string enum: - paid - free - trial availableDataFeeds: type: array items: type: string description: List of standard data feeds accessible. availableMarketplaceDataFeeds: type: object description: Marketplace API usage (separate request counter) and subscriptions. properties: dailyRateLimit: type: integer description: Marketplace daily request limit. requestsSpent: type: integer description: Marketplace requests used in the current day. timeToReset: type: string description: Time remaining to reset the marketplace counter. subscriptions: type: array items: type: string description: Enabled marketplace subscriptions. required: - name - email - subscriptionType - paymentMethod - apiRequests - apiRequestsDate - dailyRateLimit - subscriptionMode - availableDataFeeds SearchResult: type: object required: - Code - Exchange - Name - Type - Country - Currency properties: Code: type: string description: Ticker code, e.g., AAPL Exchange: type: string description: Exchange code, e.g., US, NASDAQ Name: type: string description: Instrument/company name Type: type: string description: Instrument type (Common Stock, ETF, Fund, Bond, Index, etc.) Country: type: string Currency: type: string ISIN: type: - string - 'null' previousClose: type: - number - 'null' previousCloseDate: type: - string - 'null' format: date isPrimary: type: - boolean - 'null' description: True if primary exchange for the asset additionalProperties: false WordWeightsResponse: type: object required: - data - meta - links properties: data: type: object description: Map of keyword â weight additionalProperties: type: number meta: type: object required: - news_found - news_processed properties: news_found: type: integer minimum: 0 news_processed: type: integer minimum: 0 additionalProperties: false links: type: object required: - next properties: next: type: - string - 'null' description: URL for the next page, or null additionalProperties: false additionalProperties: false Links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false MetaPagination: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false OptionsCommonAttributes: type: object description: Common fields for options contract/EOD records. Values may be null. properties: contract: type: string underlying_symbol: type: string exp_date: type: string description: YYYY-MM-DD expiration_type: type: - string - 'null' type: type: string enum: - call - put strike: type: - number - 'null' exchange: type: - string - 'null' currency: type: - string - 'null' open: type: - number - 'null' high: type: - number - 'null' low: type: - number - 'null' last: type: - number - 'null' last_size: type: - integer - 'null' change: type: - number - 'null' pctchange: type: - number - 'null' previous: type: - number - 'null' previous_date: type: - string - 'null' bid: type: - number - 'null' bid_date: type: - string - 'null' bid_size: type: - integer - 'null' ask: type: - number - 'null' ask_date: type: - string - 'null' ask_size: type: - integer - 'null' moneyness: type: - number - 'null' volume: type: - integer - 'null' volume_change: type: - integer - 'null' volume_pctchange: type: - number - 'null' open_interest: type: - integer - 'null' open_interest_change: type: - integer - 'null' open_interest_pctchange: type: - number - 'null' volatility: type: - number - 'null' volatility_change: type: - number - 'null' volatility_pctchange: type: - number - 'null' theoretical: type: - number - 'null' delta: type: - number - 'null' gamma: type: - number - 'null' theta: type: - number - 'null' vega: type: - number - 'null' rho: type: - number - 'null' tradetime: type: - string - 'null' description: YYYY-MM-DD (last trade or last market update; see docs) vol_oi_ratio: type: - number - 'null' dte: type: - integer - 'null' description: Days to expiration midpoint: type: - number - 'null' additionalProperties: false OptionsContractsItem: type: object required: - id - type - attributes properties: id: type: string type: type: string const: options-contracts attributes: type: object description: Common fields for options contract/EOD records. Values may be null. properties: contract: type: string underlying_symbol: type: string exp_date: type: string description: YYYY-MM-DD expiration_type: type: - string - 'null' type: type: string enum: - call - put strike: type: - number - 'null' exchange: type: - string - 'null' currency: type: - string - 'null' open: type: - number - 'null' high: type: - number - 'null' low: type: - number - 'null' last: type: - number - 'null' last_size: type: - integer - 'null' change: type: - number - 'null' pctchange: type: - number - 'null' previous: type: - number - 'null' previous_date: type: - string - 'null' bid: type: - number - 'null' bid_date: type: - string - 'null' bid_size: type: - integer - 'null' ask: type: - number - 'null' ask_date: type: - string - 'null' ask_size: type: - integer - 'null' moneyness: type: - number - 'null' volume: type: - integer - 'null' volume_change: type: - integer - 'null' volume_pctchange: type: - number - 'null' open_interest: type: - integer - 'null' open_interest_change: type: - integer - 'null' open_interest_pctchange: type: - number - 'null' volatility: type: - number - 'null' volatility_change: type: - number - 'null' volatility_pctchange: type: - number - 'null' theoretical: type: - number - 'null' delta: type: - number - 'null' gamma: type: - number - 'null' theta: type: - number - 'null' vega: type: - number - 'null' rho: type: - number - 'null' tradetime: type: - string - 'null' description: YYYY-MM-DD (last trade or last market update; see docs) vol_oi_ratio: type: - number - 'null' dte: type: - integer - 'null' description: Days to expiration midpoint: type: - number - 'null' additionalProperties: false additionalProperties: false OptionsEODItem: type: object required: - id - type - attributes properties: id: type: string type: type: string const: options-eod attributes: type: object description: Common fields for options contract/EOD records. Values may be null. properties: contract: type: string underlying_symbol: type: string exp_date: type: string description: YYYY-MM-DD expiration_type: type: - string - 'null' type: type: string enum: - call - put strike: type: - number - 'null' exchange: type: - string - 'null' currency: type: - string - 'null' open: type: - number - 'null' high: type: - number - 'null' low: type: - number - 'null' last: type: - number - 'null' last_size: type: - integer - 'null' change: type: - number - 'null' pctchange: type: - number - 'null' previous: type: - number - 'null' previous_date: type: - string - 'null' bid: type: - number - 'null' bid_date: type: - string - 'null' bid_size: type: - integer - 'null' ask: type: - number - 'null' ask_date: type: - string - 'null' ask_size: type: - integer - 'null' moneyness: type: - number - 'null' volume: type: - integer - 'null' volume_change: type: - integer - 'null' volume_pctchange: type: - number - 'null' open_interest: type: - integer - 'null' open_interest_change: type: - integer - 'null' open_interest_pctchange: type: - number - 'null' volatility: type: - number - 'null' volatility_change: type: - number - 'null' volatility_pctchange: type: - number - 'null' theoretical: type: - number - 'null' delta: type: - number - 'null' gamma: type: - number - 'null' theta: type: - number - 'null' vega: type: - number - 'null' rho: type: - number - 'null' tradetime: type: - string - 'null' description: YYYY-MM-DD (last trade or last market update; see docs) vol_oi_ratio: type: - number - 'null' dte: type: - integer - 'null' description: Days to expiration midpoint: type: - number - 'null' additionalProperties: false additionalProperties: false OptionsContractsResponse: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object required: - id - type - attributes properties: id: type: string type: type: string const: options-contracts attributes: type: object description: Common fields for options contract/EOD records. Values may be null. properties: contract: type: string underlying_symbol: type: string exp_date: type: string description: YYYY-MM-DD expiration_type: type: - string - 'null' type: type: string enum: - call - put strike: type: - number - 'null' exchange: type: - string - 'null' currency: type: - string - 'null' open: type: - number - 'null' high: type: - number - 'null' low: type: - number - 'null' last: type: - number - 'null' last_size: type: - integer - 'null' change: type: - number - 'null' pctchange: type: - number - 'null' previous: type: - number - 'null' previous_date: type: - string - 'null' bid: type: - number - 'null' bid_date: type: - string - 'null' bid_size: type: - integer - 'null' ask: type: - number - 'null' ask_date: type: - string - 'null' ask_size: type: - integer - 'null' moneyness: type: - number - 'null' volume: type: - integer - 'null' volume_change: type: - integer - 'null' volume_pctchange: type: - number - 'null' open_interest: type: - integer - 'null' open_interest_change: type: - integer - 'null' open_interest_pctchange: type: - number - 'null' volatility: type: - number - 'null' volatility_change: type: - number - 'null' volatility_pctchange: type: - number - 'null' theoretical: type: - number - 'null' delta: type: - number - 'null' gamma: type: - number - 'null' theta: type: - number - 'null' vega: type: - number - 'null' rho: type: - number - 'null' tradetime: type: - string - 'null' description: YYYY-MM-DD (last trade or last market update; see docs) vol_oi_ratio: type: - number - 'null' dte: type: - integer - 'null' description: Days to expiration midpoint: type: - number - 'null' additionalProperties: false additionalProperties: false links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false OptionsEODResponse: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object required: - id - type - attributes properties: id: type: string type: type: string const: options-eod attributes: type: object description: Common fields for options contract/EOD records. Values may be null. properties: contract: type: string underlying_symbol: type: string exp_date: type: string description: YYYY-MM-DD expiration_type: type: - string - 'null' type: type: string enum: - call - put strike: type: - number - 'null' exchange: type: - string - 'null' currency: type: - string - 'null' open: type: - number - 'null' high: type: - number - 'null' low: type: - number - 'null' last: type: - number - 'null' last_size: type: - integer - 'null' change: type: - number - 'null' pctchange: type: - number - 'null' previous: type: - number - 'null' previous_date: type: - string - 'null' bid: type: - number - 'null' bid_date: type: - string - 'null' bid_size: type: - integer - 'null' ask: type: - number - 'null' ask_date: type: - string - 'null' ask_size: type: - integer - 'null' moneyness: type: - number - 'null' volume: type: - integer - 'null' volume_change: type: - integer - 'null' volume_pctchange: type: - number - 'null' open_interest: type: - integer - 'null' open_interest_change: type: - integer - 'null' open_interest_pctchange: type: - number - 'null' volatility: type: - number - 'null' volatility_change: type: - number - 'null' volatility_pctchange: type: - number - 'null' theoretical: type: - number - 'null' delta: type: - number - 'null' gamma: type: - number - 'null' theta: type: - number - 'null' vega: type: - number - 'null' rho: type: - number - 'null' tradetime: type: - string - 'null' description: YYYY-MM-DD (last trade or last market update; see docs) vol_oi_ratio: type: - number - 'null' dte: type: - integer - 'null' description: Days to expiration midpoint: type: - number - 'null' additionalProperties: false additionalProperties: false links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false OptionsEODCompactResponse: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: array items: type: - string - number - integer - 'null' description: Row aligned to columns listed in meta.fields. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false UnderlyingSymbolsResponse: type: object required: - meta - data properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: string links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false IndexListItem: type: object required: - ID - Code - Name - Constituents - LastUpdate properties: ID: type: string Code: type: string Name: type: string Constituents: type: integer LastUpdate: type: string description: YYYY-MM-DD Value: type: - number - 'null' MarketCap: type: - number - 'null' Divisor: type: - number - 'null' DailyReturn: type: - number - string - 'null' Dividend: type: - number - 'null' AdjustedMarketCap: type: - number - 'null' AdjustedDivisor: type: - number - 'null' AdjustedConstituents: type: - integer - 'null' CurrencyCode: type: - string - 'null' CurrencyName: type: - string - 'null' CurrencySymbol: type: - string - 'null' additionalProperties: false IndexListResponse: type: array items: type: object required: - ID - Code - Name - Constituents - LastUpdate properties: ID: type: string Code: type: string Name: type: string Constituents: type: integer LastUpdate: type: string description: YYYY-MM-DD Value: type: - number - 'null' MarketCap: type: - number - 'null' Divisor: type: - number - 'null' DailyReturn: type: - number - string - 'null' Dividend: type: - number - 'null' AdjustedMarketCap: type: - number - 'null' AdjustedDivisor: type: - number - 'null' AdjustedConstituents: type: - integer - 'null' CurrencyCode: type: - string - 'null' CurrencyName: type: - string - 'null' CurrencySymbol: type: - string - 'null' additionalProperties: false IndexGeneral: type: object required: - Code - Type - Name - Exchange properties: Code: type: string Type: type: string Name: type: string Exchange: type: string MarketCap: type: - number - 'null' CurrencyCode: type: - string - 'null' CurrencyName: type: - string - 'null' CurrencySymbol: type: - string - 'null' CountryName: type: - string - 'null' CountryISO: type: - string - 'null' OpenFigi: type: - string - 'null' additionalProperties: false IndexComponentItem: type: object required: - Code - Exchange - Name properties: Code: type: string Exchange: type: string Name: type: string Sector: type: - string - 'null' Industry: type: - string - 'null' Weight: type: - number - 'null' additionalProperties: false IndexComponentsMap: type: object additionalProperties: type: object required: - Code - Exchange - Name properties: Code: type: string Exchange: type: string Name: type: string Sector: type: - string - 'null' Industry: type: - string - 'null' Weight: type: - number - 'null' additionalProperties: false properties: {} HistoricalComponentItem: type: object required: - Code - Name - StartDate - IsActiveNow - IsDelisted properties: Code: type: string Name: type: string StartDate: type: string description: YYYY-MM-DD EndDate: type: - string - 'null' description: YYYY-MM-DD or null IsActiveNow: type: integer enum: - 0 - 1 IsDelisted: type: integer enum: - 0 - 1 additionalProperties: false HistoricalComponentsMap: type: object additionalProperties: type: object required: - Code - Name - StartDate - IsActiveNow - IsDelisted properties: Code: type: string Name: type: string StartDate: type: string description: YYYY-MM-DD EndDate: type: - string - 'null' description: YYYY-MM-DD or null IsActiveNow: type: integer enum: - 0 - 1 IsDelisted: type: integer enum: - 0 - 1 additionalProperties: false properties: {} IndexComponentsResponse: type: object required: - General - Components - HistoricalTickerComponents properties: General: type: object required: - Code - Type - Name - Exchange properties: Code: type: string Type: type: string Name: type: string Exchange: type: string MarketCap: type: - number - 'null' CurrencyCode: type: - string - 'null' CurrencyName: type: - string - 'null' CurrencySymbol: type: - string - 'null' CountryName: type: - string - 'null' CountryISO: type: - string - 'null' OpenFigi: type: - string - 'null' additionalProperties: false Components: type: object additionalProperties: type: object required: - Code - Exchange - Name properties: Code: type: string Exchange: type: string Name: type: string Sector: type: - string - 'null' Industry: type: - string - 'null' Weight: type: - number - 'null' additionalProperties: false properties: {} HistoricalTickerComponents: type: object additionalProperties: type: object required: - Code - Name - StartDate - IsActiveNow - IsDelisted properties: Code: type: string Name: type: string StartDate: type: string description: YYYY-MM-DD EndDate: type: - string - 'null' description: YYYY-MM-DD or null IsActiveNow: type: integer enum: - 0 - 1 IsDelisted: type: integer enum: - 0 - 1 additionalProperties: false properties: {} additionalProperties: false Resp_GetTickerLogo_200_image_png: type: string format: binary Resp_GetUpcomingEarnings_200_application_json: type: object properties: type: type: string description: Type of data, e.g., 'Earnings'. description: type: string description: Description of the data, e.g., 'Historical and upcoming Earnings'. from: type: string format: date description: Start date for the earnings data. to: type: string format: date description: End date for the earnings data. earnings: type: array items: type: object properties: code: type: string description: Ticker symbol of the company. report_date: type: string format: date description: Date the earnings report was released. date: type: string format: date description: End date of the fiscal period. before_after_market: type: string description: Indicates whether the earnings report was released 'BeforeMarket' or 'AfterMarket'. currency: type: string description: Currency of the earnings values. actual: type: number description: Actual reported earnings per share or other metric. estimate: type: number description: Estimated earnings per share or other metric. difference: type: number description: Difference between actual and estimated values. percent: type: number description: Percentage difference between actual and estimated values. required: - code - report_date - date - currency example: type: Earnings description: Historical and upcoming Earnings from: '2018-12-02' to: '2018-12-05' earnings: - code: AAPL.US report_date: '2023-02-02' date: '2022-12-31' before_after_market: AfterMarket currency: USD actual: 1.88 estimate: 1.94 difference: -0.06 percent: -3.0928 - code: MSFT.US report_date: '2023-04-25' date: '2023-03-31' before_after_market: AfterMarket currency: USD actual: 2.45 estimate: 2.23 difference: 0.22 percent: 9.8655 Resp_GetUpcomingIPOs_200_application_json: type: object properties: type: type: string description: Response type, here 'IPOs'. description: type: string description: Description of the response data. from: type: string format: date description: The start date for the IPO data. to: type: string format: date description: The end date for the IPO data. ipos: type: array items: type: object properties: code: type: string description: Ticker symbol of the IPO if available. name: type: string description: Name of the company going public. exchange: type: string description: Exchange where the IPO will be listed. currency: type: string description: Currency used for the IPO pricing. start_date: type: string format: date description: Expected start date for trading. filing_date: type: string format: date description: Date when the IPO was filed. amended_date: type: string format: date description: Date when the IPO filing was amended. price_from: type: number format: float description: Lower end of the price range. price_to: type: number format: float description: Upper end of the price range. offer_price: type: number format: float description: Final offer price. shares: type: integer description: Number of shares being offered. deal_type: type: string description: Status of the IPO, e.g., 'Filed', 'Priced', 'Expected', or 'Amended'. required: - name - exchange - currency - deal_type example: type: IPOs description: Historical and upcoming IPOs from: '2018-12-02' to: '2018-12-06' ipos: - code: 603629.SHG name: Jiangsu Lettall Electn Co Ltd exchange: Shanghai currency: CNY start_date: '2018-12-11' filing_date: '2017-06-15' amended_date: '2018-12-03' price_from: 0 price_to: 0 offer_price: 0 shares: 25000000 deal_type: Expected - code: N/A name: Gsp Resource Corp exchange: TSXV currency: CAD start_date: '2018-12-03' filing_date: '2018-08-13' amended_date: '2018-11-29' price_from: 0.1523 price_to: 0.1523 offer_price: 0.2 shares: 2500000 deal_type: Priced Resp_GetUpcomingSplits_200_application_json: type: object properties: type: type: string description: Response type, here 'Splits'. description: type: string description: Description of the response data. from: type: string format: date description: The start date for the split data. to: type: string format: date description: The end date for the split data. splits: type: array items: type: object properties: code: type: string description: Ticker symbol of the stock undergoing the split. split_date: type: string format: date description: The date when the stock split takes effect. optionable: type: string enum: - Y - N description: Indicates if the stock is optionable ('Y' for yes, 'N' for no). old_shares: type: integer description: The number of shares before the split. new_shares: type: integer description: The number of shares after the split. required: - code - split_date - old_shares - new_shares example: type: Splits description: Historical and upcoming splits from: '2018-12-02' to: '2018-12-06' splits: - code: AINV.US split_date: '2018-12-03' optionable: N old_shares: 3 new_shares: 1 - code: SDV.AU split_date: '2018-12-03' optionable: N old_shares: 10 new_shares: 1 - code: 1604.TW split_date: '2018-12-04' optionable: N old_shares: 1000 new_shares: 800 Resp_GetEarningsTrends_200_application_json: type: object properties: type: type: string description: Response type, here 'Trends'. description: type: string description: Description of the response data. symbols: type: string description: Symbols for which data is returned. trends: type: array items: type: array items: type: object properties: code: type: string description: Stock symbol for which trend data is returned. date: type: string format: date description: Period end date for the trend data. period: type: string description: Period for the earnings trend (e.g., '+1y', '0y', '+1q', '0q'). growth: type: string description: Expected EPS growth as a decimal. earningsEstimateAvg: type: string description: Average EPS estimate from analysts. earningsEstimateLow: type: string description: Lowest EPS estimate from analysts. earningsEstimateHigh: type: string description: Highest EPS estimate from analysts. earningsEstimateYearAgoEps: type: string description: EPS estimate from the previous year. earningsEstimateNumberOfAnalysts: type: string description: Number of analysts contributing to the EPS estimate. earningsEstimateGrowth: type: string description: Expected EPS growth, same as 'growth'. revenueEstimateAvg: type: string description: Average revenue estimate from analysts. revenueEstimateLow: type: string description: Lowest revenue estimate from analysts. revenueEstimateHigh: type: string description: Highest revenue estimate from analysts. revenueEstimateYearAgoEps: type: string description: Revenue estimate from the previous year. revenueEstimateNumberOfAnalysts: type: string description: Number of analysts contributing to the revenue estimate. revenueEstimateGrowth: type: string description: Expected growth in revenue. epsTrendCurrent: type: string description: Current EPS estimate. epsTrend7daysAgo: type: string description: EPS estimate 7 days ago. epsTrend30daysAgo: type: string description: EPS estimate 30 days ago. epsTrend60daysAgo: type: string description: EPS estimate 60 days ago. epsTrend90daysAgo: type: string description: EPS estimate 90 days ago. epsRevisionsUpLast7days: type: string description: Number of upward EPS revisions in the last 7 days. epsRevisionsUpLast30days: type: string description: Number of upward EPS revisions in the last 30 days. epsRevisionsDownLast7days: type: string description: Number of downward EPS revisions in the last 7 days. epsRevisionsDownLast30days: type: string description: Number of downward EPS revisions in the last 30 days. required: - code - date - period - earningsEstimateAvg example: type: Trends description: Historical and upcoming earning trends symbols: AAPL.US trends: - - code: AAPL.US date: '2025-09-30' period: +1y growth: '0.1200' earningsEstimateAvg: '7.4700' earningsEstimateLow: '6.8800' earningsEstimateHigh: '7.9300' earningsEstimateYearAgoEps: '6.6700' earningsEstimateNumberOfAnalysts: '42' earningsEstimateGrowth: '0.1200' revenueEstimateAvg: '420689000000.00' revenueEstimateLow: '401691000000.00' revenueEstimateHigh: '441882000000.00' revenueEstimateYearAgoEps: '' revenueEstimateNumberOfAnalysts: '40' revenueEstimateGrowth: '0.0780' epsTrendCurrent: '7.4700' epsTrend7daysAgo: '7.4800' epsTrend30daysAgo: '7.4800' epsTrend60daysAgo: '7.4800' epsTrend90daysAgo: '7.3400' epsRevisionsUpLast7days: '1' epsRevisionsUpLast30days: '4' epsRevisionsDownLast30days: '3' Resp_GetHistoricalDividends_200_application_json: type: array items: type: object properties: date: type: string format: date description: Ex-dividend date. declarationDate: type: string format: date description: Declaration date of the dividend. recordDate: type: string format: date description: Record date for dividend eligibility. paymentDate: type: string format: date description: Dividend payment date. period: type: string description: Dividend period (e.g., 'Quarterly'). value: type: number format: float description: Dividend value per share in the specified currency. unadjustedValue: type: number format: float description: Unadjusted dividend value before stock splits and other adjustments. currency: type: string description: Currency in which the dividend is paid (e.g., 'USD'). required: - date - value - currency Resp_GetEconomicEventsData_200_application_json: type: array items: type: object properties: type: type: string description: Type of economic event, e.g., 'Nonfarm Payrolls'. comparison: type: - string - 'null' description: Comparison type (e.g., 'mom', 'qoq', 'yoy'). period: type: - string - 'null' description: Period associated with the data, e.g., 'May'. country: type: string description: Country code in ISO 3166 format. date: type: string format: date-time description: Date and time of the event in 'YYYY-MM-DD HH:MM:SS' format. actual: type: - number - 'null' description: Actual reported value for the event. previous: type: - number - 'null' description: Previous value for the event. estimate: type: - number - 'null' description: Estimated value for the event. change: type: - number - 'null' description: Change in value from previous. change_percentage: type: - number - 'null' description: Percentage change in value from previous. Resp_GetEODDataByTicker_200_application_json: oneOf: - type: array items: type: object properties: date: type: string format: date open: type: number high: type: number low: type: number close: type: number adjusted_close: type: number volume: type: integer - type: number description: Single value for the specified filter query (e.g., last close price) Resp_GetBulkEODData_200_application_json: oneOf: - type: array items: type: object properties: code: type: string description: Ticker code. exchange_short_name: type: string description: Exchange symbol. date: type: string format: date description: Data date. open: type: number description: Open price. high: type: number description: High price. low: type: number description: Low price. close: type: number description: Close price. adjusted_close: type: number description: Adjusted close price. volume: type: integer description: Trading volume. - type: array items: type: object properties: code: type: string description: Ticker code. exchange: type: string description: Exchange symbol. date: type: string format: date description: Date of the split. split: type: string description: Stock split ratio. description: Bulk splits data. - type: array items: type: object properties: code: type: string description: Ticker code. exchange: type: string description: Exchange symbol. date: type: string format: date description: Date of dividend. dividend: type: number description: Dividend amount. currency: type: string description: Dividend currency. declarationDate: type: - string - 'null' format: date description: Declaration date (if available). recordDate: type: - string - 'null' format: date description: Record date (if available). paymentDate: type: - string - 'null' format: date description: Payment date (if available). period: type: - string - 'null' description: Period type (if available). unadjustedValue: type: number description: Unadjusted dividend value. description: Bulk dividends data. Resp_GetExchangeDetails_200_application_json: type: object properties: Name: type: string Code: type: string OperatingMIC: type: string Country: type: string Currency: type: string Timezone: type: string ExchangeHolidays: type: array items: type: object properties: Holiday: type: string Date: type: string format: date Type: type: string ExchangeEarlyCloseDays: type: array items: type: object properties: Date: type: string format: date CloseTime: type: string format: time isOpen: type: boolean TradingHours: type: object properties: Open: type: string format: time Close: type: string format: time OpenUTC: type: string format: time CloseUTC: type: string format: time WorkingDays: type: string ActiveTickers: type: integer PreviousDayUpdatedTickers: type: integer UpdatedTickers: type: integer Resp_GetListOfExchanges_200_application_json: type: array items: type: object properties: Name: type: string Code: type: string OperatingMIC: type: - string - 'null' Country: type: string Currency: type: string CountryISO2: type: string CountryISO3: type: string Resp_GetExchangeSymbolList_200_application_json: type: array items: type: object properties: Code: type: string description: Ticker symbol code. Name: type: string description: Company name associated with the ticker. Country: type: string description: Country of the exchange. Exchange: type: string description: Exchange code. Currency: type: string description: Currency code in which the stock is traded. Type: type: string description: Type of ticker (e.g., Common Stock, ETF). Isin: type: - string - 'null' description: ISIN code if available. Resp_GetFundamentalData_200_application_json: type: object properties: General: type: object description: General company information properties: Code: type: string Name: type: string Exchange: type: string Sector: type: string Highlights: type: object description: Key financial highlights properties: MarketCapitalization: type: number EBITDA: type: number PERatio: type: number Valuation: type: object description: Company valuation metrics properties: TrailingPE: type: number ForwardPE: type: number EnterpriseValue: type: number SharesStats: type: object description: Shares statistics properties: SharesOutstanding: type: number SharesFloat: type: number PercentInstitutions: type: number Technicals: type: object description: Technical indicators properties: Beta: type: number 52WeekHigh: type: number 52WeekLow: type: number SplitsDividends: type: object description: Dividend and split information properties: DividendYield: type: number DividendDate: type: string format: date LastSplitFactor: type: string AnalystRatings: type: object description: Analyst ratings properties: Rating: type: number StrongBuy: type: integer Sell: type: integer Holders: type: object description: Institutional and fund holders properties: Institutions: type: array items: type: object properties: name: type: string totalShares: type: number Funds: type: array items: type: object properties: name: type: string totalShares: type: number InsiderTransactions: type: array description: Insider transactions items: type: object properties: date: type: string format: date ownerName: type: string transactionCode: type: string transactionAmount: type: number ESGScores: type: object description: Environmental, social, and governance scores properties: environmentScore: type: number socialScore: type: number governanceScore: type: number outstandingShares: type: object description: Outstanding shares data properties: annual: type: array items: type: object properties: date: type: string format: date shares: type: number quarterly: type: array items: type: object properties: date: type: string format: date shares: type: number Earnings: type: object description: Earnings data properties: History: type: array items: type: object properties: date: type: string format: date epsActual: type: number Trend: type: array items: type: object properties: period: type: string epsEstimateAvg: type: number Financials: type: object description: Financial statements properties: Balance_Sheet: type: object description: Balance sheet data properties: annual: type: array items: type: object description: Generic financial statement row. Contains a required 'date' plus arbitrary key-value pairs for line items. properties: date: type: string format: date description: Statement period end date. additionalProperties: oneOf: - type: number - type: integer - type: string - type: boolean - type: 'null' required: - date quarterly: type: array items: type: object description: Generic financial statement row. Contains a required 'date' plus arbitrary key-value pairs for line items. properties: date: type: string format: date description: Statement period end date. additionalProperties: oneOf: - type: number - type: integer - type: string - type: boolean - type: 'null' required: - date Income_Statement: type: object description: Income statement data properties: annual: type: array items: type: object description: Generic financial statement row. Contains a required 'date' plus arbitrary key-value pairs for line items. properties: date: type: string format: date description: Statement period end date. additionalProperties: oneOf: - type: number - type: integer - type: string - type: boolean - type: 'null' required: - date quarterly: type: array items: type: object description: Generic financial statement row. Contains a required 'date' plus arbitrary key-value pairs for line items. properties: date: type: string format: date description: Statement period end date. additionalProperties: oneOf: - type: number - type: integer - type: string - type: boolean - type: 'null' required: - date Cash_Flow: type: object description: Cash flow data properties: annual: type: array items: type: object description: Generic financial statement row. Contains a required 'date' plus arbitrary key-value pairs for line items. properties: date: type: string format: date description: Statement period end date. additionalProperties: oneOf: - type: number - type: integer - type: string - type: boolean - type: 'null' required: - date quarterly: type: array items: type: object description: Generic financial statement row. Contains a required 'date' plus arbitrary key-value pairs for line items. properties: date: type: string format: date description: Statement period end date. additionalProperties: oneOf: - type: number - type: integer - type: string - type: boolean - type: 'null' required: - date Resp_GetHistoricalMarketCap_200_application_json: type: object properties: data: type: array items: type: object properties: date: type: string format: date description: The date of the market capitalization value. value: type: number description: Market capitalization value in USD. required: - date - value Resp_GetInsiderTransactions_200_application_json: type: array items: type: object properties: code: type: string description: Ticker symbol of the company exchange: type: string description: Exchange where the stock is listed date: type: string format: date description: Report date of the transaction reportDate: type: string format: date description: Date the transaction was reported to the SEC ownerCik: type: - string - 'null' description: Unique identifier for the owner in SEC filings ownerName: type: string description: Name of the insider who executed the transaction ownerRelationship: type: - string - 'null' description: Relationship of the owner to the company (e.g., Director) ownerTitle: type: string description: Title or role of the insider in the company transactionDate: type: string format: date description: Date when the transaction occurred transactionCode: type: string enum: - P - S description: 'Type of transaction: ''P'' for Purchase, ''S'' for Sale' transactionAmount: type: integer description: Number of shares involved in the transaction transactionPrice: type: number format: float description: Price per share at the time of the transaction transactionAcquiredDisposed: type: string enum: - A - D description: Indicates whether securities were Acquired (A) or Disposed (D) postTransactionAmount: type: - integer - 'null' description: Total number of shares held by the insider post-transaction link: type: string format: uri description: Link to the original SEC filing document Resp_GetIntradayHistoricalData_200_application_json: type: array items: type: object properties: timestamp: type: integer gmtoffset: type: integer datetime: type: string format: date-time open: type: number high: type: number low: type: number close: type: number volume: type: - integer - 'null' Resp_GetMacroIndicatorData_200_application_json: type: array items: type: object properties: CountryCode: type: string description: ISO Alpha-3 country code, e.g., 'USA' for United States. CountryName: type: string description: Country name, e.g., 'United States'. Indicator: type: string description: Indicator name, e.g., 'Inflation, consumer prices (annual %)'. Date: type: string format: date description: Date of the recorded value. Period: type: string description: Period of the data, e.g., 'Annual'. Value: type: number description: Recorded value of the indicator. Resp_getOptionsEOD_200_application_json: oneOf: - type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object required: - id - type - attributes properties: id: type: string type: type: string const: options-eod attributes: type: object description: Common fields for options contract/EOD records. Values may be null. properties: contract: type: string underlying_symbol: type: string exp_date: type: string description: YYYY-MM-DD expiration_type: type: - string - 'null' type: type: string enum: - call - put strike: type: - number - 'null' exchange: type: - string - 'null' currency: type: - string - 'null' open: type: - number - 'null' high: type: - number - 'null' low: type: - number - 'null' last: type: - number - 'null' last_size: type: - integer - 'null' change: type: - number - 'null' pctchange: type: - number - 'null' previous: type: - number - 'null' previous_date: type: - string - 'null' bid: type: - number - 'null' bid_date: type: - string - 'null' bid_size: type: - integer - 'null' ask: type: - number - 'null' ask_date: type: - string - 'null' ask_size: type: - integer - 'null' moneyness: type: - number - 'null' volume: type: - integer - 'null' volume_change: type: - integer - 'null' volume_pctchange: type: - number - 'null' open_interest: type: - integer - 'null' open_interest_change: type: - integer - 'null' open_interest_pctchange: type: - number - 'null' volatility: type: - number - 'null' volatility_change: type: - number - 'null' volatility_pctchange: type: - number - 'null' theoretical: type: - number - 'null' delta: type: - number - 'null' gamma: type: - number - 'null' theta: type: - number - 'null' vega: type: - number - 'null' rho: type: - number - 'null' tradetime: type: - string - 'null' description: YYYY-MM-DD (last trade or last market update; see docs) vol_oi_ratio: type: - number - 'null' dte: type: - integer - 'null' description: Days to expiration midpoint: type: - number - 'null' additionalProperties: false additionalProperties: false links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false - type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: array items: type: - string - number - integer - 'null' description: Row aligned to columns listed in meta.fields. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_getIndexComponents_401_text_html: type: string Resp_getIndexComponents_403_text_html: type: string Resp_getIndexComponents_404_text_html: type: string Resp_getIndexComponents_429_text_html: type: string Resp_listIndicesWithDetails_401_text_html: type: string Resp_listIndicesWithDetails_403_text_html: type: string Resp_listIndicesWithDetails_429_text_html: type: string Resp_GetFinancialNews_200_application_json: type: array items: type: object properties: date: type: string format: date-time title: type: string content: type: string link: type: string format: uri symbols: type: array items: type: string tags: type: array items: type: string sentiment: type: object properties: polarity: type: number neg: type: number neu: type: number pos: type: number Resp_GetLiveDelayedStockPrices_200_application_json: oneOf: - type: object properties: code: type: string timestamp: type: integer gmtoffset: type: integer open: type: number high: type: number low: type: number close: type: number volume: type: integer previousClose: type: number change: type: number change_p: type: number - type: array items: type: object properties: code: type: string timestamp: type: integer gmtoffset: type: integer open: type: number high: type: number low: type: number close: type: number volume: type: - integer - 'null' previousClose: type: number change: type: number change_p: type: number Resp_GetStockScreenerData_200_application_json: type: object properties: data: type: array items: type: object properties: code: type: string description: Ticker symbol. name: type: string description: Company name. last_day_data_date: type: string format: date description: Date of the latest data. adjusted_close: type: number description: Latest adjusted close price. refund_1d: type: number description: Refund value for the last day. refund_1d_p: type: number description: Refund percentage change for the last day. refund_5d: type: number description: Refund value for the last 5 days. refund_5d_p: type: number description: Refund percentage change for the last 5 days. exchange: type: string description: Exchange code. currency_symbol: type: string description: Currency symbol. market_capitalization: type: integer description: Market capitalization in USD. earnings_share: type: number description: Earnings per share (EPS). dividend_yield: type: number description: Dividend yield percentage. sector: type: string description: Company sector. industry: type: string description: Company industry. avgvol_1d: type: integer description: Average daily volume for the last day. avgvol_200d: type: number description: Average daily volume over the last 200 days. Resp_SearchStocksByQuery_200_application_json: type: array items: type: object properties: Code: type: string Exchange: type: string Name: type: string Type: type: string Country: type: string Currency: type: string ISIN: type: - string - 'null' previousClose: type: number previousCloseDate: type: string format: date Resp_GetSentimentData_200_application_json: type: object properties: ticker: type: object additionalProperties: type: array items: type: object properties: date: type: string format: date count: type: integer description: Number of articles or mentions analyzed for the given date. normalized: type: number minimum: -1 maximum: 1 description: Normalized sentiment score, where -1 represents a very negative sentiment, 0 is neutral, and 1 is very positive. required: - date - count - normalized Resp_GetHistoricalSplits_200_application_json: type: array items: type: object properties: date: type: string format: date description: Date of the stock split. split: type: string description: Split ratio represented as '{new shares}/{old shares}' (e.g., '2.000000/1.000000'). required: - date - split Resp_GetSymbolChangeHistory_200_application_json: type: array items: type: object properties: exchange: type: string old_symbol: type: string new_symbol: type: string company_name: type: string effective: type: string format: date Resp_GetTechnicalIndicatorData_200_application_json: type: array items: type: object properties: date: type: string format: date description: Date of the data point. sma: type: number description: Simple Moving Average value (specific to the chosen function). Resp_GetTickData_200_application_json: type: object properties: ex: type: array items: type: string description: List of exchanges where transactions took place. mkt: type: array items: type: string description: Market where trade took place. price: type: array items: type: number description: Price of the transaction. seq: type: array items: type: integer description: Trade sequence number. shares: type: array items: type: integer description: Number of shares in the transaction. sl: type: array items: type: string description: Sales condition codes for the trades. sub_mkt: type: array items: type: string description: Sub-market where trade took place. ts: type: array items: type: integer format: int64 description: Timestamp of each transaction in milliseconds since epoch. FinancialStatementRow: type: object description: Generic financial statement row. Contains a required 'date' plus arbitrary key-value pairs for line items. properties: date: type: string format: date description: Statement period end date. additionalProperties: oneOf: - type: number - type: integer - type: string - type: boolean - type: 'null' required: - date IndexComponent: type: object properties: Code: type: string Exchange: type: string Name: type: string Sector: type: - string - 'null' Industry: type: - string - 'null' Weight: type: - number - 'null' required: - Code - Exchange - Name HistoricalIndexComponent: type: object properties: Code: type: string Name: type: string StartDate: type: - string - 'null' format: date EndDate: type: - string - 'null' format: date IsActiveNow: type: - integer - boolean IsDelisted: type: - integer - boolean required: - Code - Name - IsActiveNow - IsDelisted Resp_GetSovereignRiskPremium_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: country_iso3: type: string description: ISO Alpha-3 country code. country_name: type: string description: Country name. as_of_date: type: string format: date-time description: As-of timestamp for the values. moodys_rating: type: string description: Moody's sovereign credit rating. adj_default_spread: type: number description: Adjusted default spread. country_risk_premium: type: number description: Country risk premium. equity_risk_premium: type: number description: Total equity risk premium. corporate_tax_rate: type: number description: Corporate tax rate. sovereign_cds: type: - number - 'null' description: Sovereign CDS spread, if available. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetSovereignCreditRatings_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: country_iso3: type: string description: ISO Alpha-3 country code. country_name: type: string description: Country name. as_of_date: type: string format: date-time description: As-of timestamp for the ratings. moodys_rating: type: string description: Moody's sovereign credit rating. sp_rating: type: string description: S&P sovereign credit rating. fitch_rating: type: string description: Fitch sovereign credit rating. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetSovereignCdsSpreads_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: country_iso3: type: string description: ISO Alpha-3 country code. country_name: type: string description: Country name. as_of_date: type: string format: date-time description: As-of timestamp for the spreads. moodys_rating: type: string description: Moody's sovereign credit rating. cds_spread: type: - number - 'null' description: Sovereign CDS spread. cds_spread_net_of_switzerland: type: - number - 'null' description: CDS spread net of Switzerland. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetSovereignDefaultSpreads_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: rating: type: string description: Credit rating bucket. as_of_date: type: string format: date-time description: As-of timestamp for the spread. default_spread: type: number description: Default spread for the rating bucket. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetCorporateCmdi_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: as_of_date: type: string format: date-time description: As-of timestamp for the index values. market_cmdi: type: number description: Overall market CMDI value. ig_cmdi: type: number description: Investment-grade CMDI value. hy_cmdi: type: number description: High-yield CMDI value. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetCorporateHqmYields_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: series_id: type: string description: Source series identifier. tenor_years: type: number description: Tenor in years. yield_type: type: string description: Yield curve type (par or spot). as_of_date: type: string format: date-time description: As-of timestamp for the yield value. yield_value: type: number description: Yield value. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetCdsMarketAggregates_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: as_of_date: type: string format: date-time description: As-of timestamp for the aggregate. release_date: type: string format: date-time description: Release timestamp of the aggregate. metric: type: string description: Aggregate metric name. breakdown_dimension: type: string description: Dimension used for the breakdown. breakdown_value: type: string description: Value of the breakdown dimension. region: type: string description: Region. usd_notional_mn: type: number description: Notional amount in USD millions. source: type: string description: Data source. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetSanctionsEntities_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: id: type: integer description: Unique identifier of the record. source: type: string description: Sanctions data source (e.g., 'OFAC'). source_uid: type: string description: Unique identifier of the entity within the source. entity_type: type: string description: Type of entity (e.g., individual, entity, vessel). name: type: string description: Primary name of the sanctioned entity. programs: type: array description: Sanctions program codes the entity is listed under. items: type: string country: type: - string - 'null' description: Associated country. remarks: type: - string - 'null' description: Free-text remarks from the source listing. listed_date: type: - string - 'null' description: Date the entity was listed. is_active: type: boolean description: Whether the listing is currently active. aliases: type: array description: Known aliases for the entity. items: type: string identifiers: type: array description: Identification documents or numbers associated with the entity. items: type: object additionalProperties: true links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetSanctionsVessels_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: id: type: integer description: Unique identifier of the record. call_sign: type: - string - 'null' description: Vessel call sign. vessel_type: type: - string - 'null' description: Type of vessel. flag: type: - string - 'null' description: Flag (country of registration). tonnage: type: - number - 'null' description: Vessel tonnage. gross_tonnage: type: - number - 'null' description: Gross registered tonnage. owner: type: - string - 'null' description: Vessel owner. imo_number: type: - string - 'null' description: IMO number. mmsi: type: - string - 'null' description: Maritime Mobile Service Identity. entity_source_uid: type: string description: Source UID of the linked sanctioned entity. entity_name: type: string description: Name of the linked sanctioned entity. source: type: string description: Sanctions data source (e.g., 'OFAC'). programs: type: array description: Sanctions program codes the vessel is listed under. items: type: string country: type: string description: Associated country. is_active: type: boolean description: Whether the listing is currently active. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetSanctionsPrograms_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: program: type: string description: Sanctions program code. count: type: integer description: Number of entities listed under the program. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetSanctionsSources_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: name: type: string description: Sanctions source name. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetReferenceRates_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: date: type: string format: date description: Observation date. code: type: string description: Reference rate code. currency: type: string description: Currency of the rate. rate_type: type: string description: Type of rate. rate: type: number description: Rate value. source: type: string description: Data source. source_series_id: type: string description: Source series identifier. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetPolicyRates_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: date: type: string format: date description: Observation date. code: type: string description: Policy rate code. country: type: string description: Country. central_bank: type: string description: Central bank. rate: type: number description: Policy rate value. source: type: string description: Data source. source_series_id: type: string description: Source series identifier. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false Resp_GetFundingStressSpreads_200_application_json: type: object required: - meta - data - links properties: meta: type: object description: Pagination and field metadata. required: - total - fields properties: offset: type: integer minimum: 0 limit: type: integer minimum: 1 total: type: integer minimum: 0 fields: type: array items: type: string compact: type: - boolean - 'null' additionalProperties: false data: type: array items: type: object properties: date: type: string format: date description: Observation date. code: type: string description: Spread code. value_bps: type: number description: Spread value in basis points. formula: type: string description: Formula used to compute the spread. leg_a: type: string description: First rate leg code. leg_b: type: string description: Second rate leg code. leg_a_rate: type: number description: Rate value of the first leg. leg_b_rate: type: number description: Rate value of the second leg. links: type: object required: - next properties: next: type: - string - 'null' description: URL to fetch the next page, or null if last page. additionalProperties: false additionalProperties: false