{ "openapi": "3.1.0", "info": { "title": "Bigdata Structured Data API", "description": "Bigdata API documentation", "version": "1.0.0" }, "servers": [ { "url": "https://api.bigdata.com/" } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/v1/price/daily/query": { "post": { "tags": [ "Market Data" ], "summary": "Daily Prices", "description": "Returns daily historical price and volume data for a given symbol. Supports\nstocks, ETFs, indexes, cryptocurrencies, commodities (continuous futures) and forex pairs. Each\ndata point includes date, open, high, low, close, volume, change, change percentage,\nand volume-weighted average price (VWAP). Ideal for tracking daily market performance\nand conducting technical analysis over extended periods.", "operationId": "query_daily_prices_v1_price_daily_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DailyPricesQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DailyPricesResponse" } } } } } } }, "/v1/price/intraday/query": { "post": { "tags": [ "Market Data" ], "summary": "Intraday Prices", "description": "Returns intraday historical price and volume data for a given symbol at specified intervals (e.g. 1min, 5min, 15min, 30min, 1hour). Supports stocks, ETFs, commodities (continuous futures), indexes, cryptocurrencies, and forex pairs. Each data point includes timestamp, open, high, low, close, and volume.", "operationId": "query_intraday_prices_v1_price_intraday_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntradayPricesQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntradayPricesResponse" } } } } } } }, "/v1/price/aftermarket/query": { "post": { "tags": [ "Market Data" ], "summary": "Aftermarket Prices", "description": "Returns the latest extended-hours (aftermarket) trade and quote for one or more companies. Each record includes the last aftermarket trade (price, size, timestamp) and quote (best bid/ask price and size, cumulative volume, timestamp).", "operationId": "query_aftermarket_v1_price_aftermarket_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AftermarketQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AftermarketResponse" } } } } } } }, "/v1/dividends/query": { "post": { "tags": [ "Market Data" ], "summary": "Dividends", "description": "Returns historical and upcoming dividend data for companies. Supports stocks and ETFs. Each dividend record includes ex-dividend date, record date, payment date, declaration date, dividend amount, adjusted dividend, yield, and frequency.", "operationId": "query_dividends_v1_dividends_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DividendsQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DividendsResponse" } } } } } } }, "/v1/price/changes/query": { "post": { "tags": [ "Market Data" ], "summary": "Price Changes", "description": "This endpoint track price fluctuations in real-time with the Price Changes API. Monitor percentage changes over various time periods, including daily (1D), monthly (1M), yearly (1Y) and long-term (max).", "operationId": "query_price_changes_v1_price_changes_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceChangesQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPriceChangesResponse" } } } } } } }, "/v1/quote/query": { "post": { "tags": [ "Market Data" ], "summary": "Quote", "description": "This endpoint provides real-time asset quotes with the Quote API. Access up-to-the-minute prices, price changes, and trading volume for individual assets, ensuring you stay on top of market movements. Assets covered include stocks, cryptocurrencies, commodities, and ETFs.", "operationId": "query_company_quote_v1_quote_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyQuoteQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyQuoteResponse" } } } } } } }, "/v1/analyst-estimates/query": { "post": { "tags": [ "Analyst Estimates" ], "summary": "Analyst Estimates", "description": "Retrieves analyst financial estimates for a given symbol, including projected revenue,\nearnings per share (EPS), and other key metrics, as forecasted by industry analysts.", "operationId": "query_analyst_estimates_v1_analyst_estimates_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicAnalystEstimatesQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicAnalystEstimatesResponse" } } } } } } }, "/v1/analyst-ratings/query": { "post": { "tags": [ "Analyst Estimates" ], "summary": "Analyst Ratings", "description": "Retrieves analyst ratings and recommendations for a given symbol, including\nbuy/hold/sell counts and the consensus recommendations.", "operationId": "query_analyst_ratings_v1_analyst_ratings_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystRatingsQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystRatingsResponse" } } } } } } }, "/v1/latest-surprise/query": { "post": { "tags": [ "Analyst Estimates" ], "summary": "Earnings Surprises", "description": "The Earnings Surprises API allows users to retrieve the most recent quarterly\nearnings surprise data for a specific company. This endpoint provides actual versus\nestimated earnings per share (EPS) and revenue (sales), highlighting whether the\ncompany has beaten, missed, or met expectations.", "operationId": "query_latest_surprise_v1_latest_surprise_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LatestSurpriseQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LatestSurpriseResponse" } } } } } } }, "/v1/price/target/query": { "post": { "tags": [ "Analyst Estimates" ], "summary": "Target Price", "description": "This endpoint retrieves target price for a company, including target high, target low, target consensus, and target median.", "operationId": "query_target_price_v1_target_price_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetPriceQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTargetPriceResponse" } } } } } } }, "/v1/balance-sheet/query": { "post": { "tags": [ "Financials & Ratios" ], "summary": "Balance Sheet", "description": "This endpoint retrieves fundamental balance sheet measures for a company, including assets, liabilities, and equity across reporting periods.", "operationId": "query_balance_sheet_v1_balance_sheet_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBalanceSheetQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBalanceSheetResponse" } } } } } } }, "/v1/cash-flow-statement/query": { "post": { "tags": [ "Financials & Ratios" ], "summary": "Cash Flow Statement", "description": "This endpoint retrieves fundamental cash flow statement measures for a company, including operating, investing, and financing cash flows across reporting periods.", "operationId": "query_cash_flow_statement_v1_cash_flow_statement_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCashFlowStatementQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCashFlowResponse" } } } } } } }, "/v1/company-ratios-ttm/query": { "post": { "tags": [ "Financials & Ratios" ], "summary": "Company Ratios TTM", "description": "Retrieves fundamental company ratios for a company, including revenue, expenses, and profitability metrics across reporting periods.", "operationId": "query_company_ratios_ttm_v1_company_ratios_ttm_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRatiosTTMQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRatiosTTMResponse" } } } } } } }, "/v1/income-statement/query": { "post": { "tags": [ "Financials & Ratios" ], "summary": "Income Statement", "description": "This endpoint retrieves fundamental income statement measures for a company, including revenue, expenses, and profitability metrics across reporting periods.", "operationId": "query_income_statement_v1_income_statement_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicIncomeStatementQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicIncomeStatementResponse" } } } } } } }, "/v1/key-metrics-ttm/query": { "post": { "tags": [ "Financials & Ratios" ], "summary": "Key Metrics TTM", "description": "The Key Metrics TTM API provides seamless access to a comprehensive set of trailing\ntwelve-month (TTM) performance indicators. It delivers insights into a company's\nprofitability, capital efficiency, and liquidity, enabling in-depth evaluation of\nfinancial health and operational performance over the past year.", "operationId": "query_key_metrics_TTM_v1_key_metrics_ttm_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyMetricsTTMQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyMetricsTTMResponse" } } } } } } }, "/v1/company-revenue-geographic-segments/query": { "post": { "tags": [ "Financials & Ratios" ], "summary": "Revenue Geographic Segments", "description": "The Revenue Geographic Segments API allows users to retrieve revenue data segmented by geographical regions, helping investors and analysts understand the performance of a company in different markets.", "operationId": "query_company_revenue_geographic_v1_company_revenue_geographic_segments_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyRevenueGeographicQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyRevenueGeographicResponse" } } } } } } }, "/v1/company-revenue-product-segments/query": { "post": { "tags": [ "Financials & Ratios" ], "summary": "Revenue Product Segments", "description": "The Revenue Product Segments API provides access to detailed revenue data broken down by individual products. This enables investors and analysts to gain deeper insights into a company’s performance across its product portfolio.", "operationId": "query_company_revenue_product_v1_company_revenue_product_segments_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyRevenueProductQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyRevenueProductResponse" } } } } } } }, "/v1/company-profile/query": { "post": { "tags": [ "Company & Events" ], "summary": "Company Profile", "description": "This endpoint retrieves comprehensive company profile data including company name, sector, industry, CEO, market cap, and other key business information.", "operationId": "query_company_profile_v1_company_profile_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentifierQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyProfileResponse" } } } } } } }, "/v1/company-screener/query": { "post": { "tags": [ "Company & Events" ], "summary": "Stocks & Funds Screener", "description": "The Company Screener API enables advanced filtering and discovery of companies based on comprehensive financial and descriptive criteria. \n\nFilter companies by market capitalization, stock price, beta, trading volume, dividend yield, sector, industry, country, exchange, \nand trading status. Perfect for investment research, portfolio construction, and market analysis.\n", "operationId": "query_company_screener_v1_company_screener_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyScreenerQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyScreenerResponse" } } } } } } }, "/v1/events-calendar/query": { "post": { "tags": [ "Company & Events" ], "summary": "Events Calendar", "description": "A financial data API that returns details of key corporate events, such as earnings\ncalls, conference calls, US IPO listings, and US delistings. Query by a specific list of\ncompanies, by date range alone, or both, allowing investors and analysts to track upcoming\nand historical company announcements in real time.", "operationId": "query_events_calendar_v1_events_calendar_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventsCalendarQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventsCalendarResponse" } } } } } } }, "/v1/holdings/funds/stocks/": { "post": { "tags": [ "Fund Holdings" ], "summary": "Fund Holdings", "description": "Retrieve portfolio holdings disclosed by institutional funds in their SEC 13F filings. This dataset provides an overview of a fund’s positions, including the total number of holdings, overall portfolio size, and high-level summaries such as top holdings and allocation trends. It also allows retrieval of the top buys and sells for a fund or fund manager, either for the latest portfolio or for historical quarters. Sector composition of the fund’s portfolio can also be accessed.", "operationId": "Holdings_v1_holdings_funds_stocks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicGetHoldingsOverviewQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicGetHoldingsOverviewResponse" } } } } } } }, "/v1/holdings/stocks/funds": { "post": { "tags": [ "Fund Holdings" ], "summary": "Stock Fund Holdings", "description": "Retrieve institutional fund holdings for a specified stock, based on the latest SEC 13F filings. The endpoint returns top holders with their current market value, share count, quarterly change, and estimated capital flow. This allows users to identify leading institutional investors, track changes in ownership, and analyze fund activity trends such as increases or reductions in positions.", "operationId": "Stock_Funds_Holdings_v1_holdings_stocks_funds_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicGetCompanyFundsHoldingsQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicGetCompanyFundsHoldingsResponse" } } } } } } }, "/v1/holdings/funds/trends/": { "post": { "tags": [ "Fund Holdings" ], "summary": "Fund Position Signals", "description": "Retrieve a strategic overview of top stocks based on aggregated position changes by hedge funds, utilizing data from the most recent SEC 13F filings. This endpoint provides a detailed overview of fund activities, capturing changes across calls, puts, new positions, closures, and net adjustments. It highlights where hedge funds are intensifying their focus, reducing exposure, or completely shifting their investment strategies, helping users identify trends and strategic moves in the market.", "operationId": "Fund_Position_Signals_v1_holdings_funds_trends__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicGetFundTrendsQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicFundTrendsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsError" } } } } } } }, "/v1/entity-sentiment/": { "post": { "tags": [ "Market Data" ], "summary": "Entity Sentiment", "description": "Returns a time series of daily sentiment metrics for a single entity over a specified date range. Sentiment is a quantified signal derived from unstructured text using rule-based and machine-learning methods, indicating likely positive or negative market impact. The response includes daily_sentiment (mean sentiment), sentiment_pressure (abnormal sentiment intensity), and abnormal_media_attention (abnormal media volume).", "operationId": "query_entity_sentiment_v1_entity_sentiment__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeSeriesSentimentQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeSeriesSentimentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsError" } } } } } } }, "/v1/esg-performance-score/query": { "post": { "tags": [ "Company & Events" ], "summary": "ESG Scores", "description": "The ESG Performance Score API provides a comprehensive evaluation of a company's environmental, social, and governance (ESG) practices. It aggregates various ESG metrics into a single performance score, allowing investors and stakeholders to assess the company's commitment to sustainable and responsible business operations.\n\nThe ESG scores reflect companies' sustainability performance relative to financially material ESG issues. Scores are derived from standardized company-reported data and peer-based relative scoring techniques, resulting in a 0–100 scale that indicates a company's position versus its global peers, following a sector-specific, SASB (Sustainability Accounting Standards Board)-inspired materiality framework.\n\n| Performance | Score Range |\n|---|---|\n| Laggard | < 42 |\n| Below Average | 42 - 47 |\n| Average | 48 - 53 |\n| Above Average | 54 - 59 |\n| Leader | ≥ 60 |", "operationId": "query_esg_performance_score_v1_esg_performance_score__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicGetPerformanceScoreQuery" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicESGPerformanceScoreResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsError" } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } }, "schemas": { "AftermarketQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the latest extended-hours (aftermarket) trade and quote. You must supply one type and its corresponding value, or a list of values.", "examples": [ { "type": "rp_entity_id", "value": "4A6F00" } ] } }, "type": "object", "required": [ "identifier" ], "title": "AftermarketQuery" }, "AftermarketTrade": { "properties": { "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price", "description": "The last extended-hours trade price.", "examples": [ 245.79 ] }, "trade_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Trade Size", "description": "The size (number of shares) of the last extended-hours trade.", "examples": [ 100 ] }, "timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp", "description": "The time of the last extended-hours trade (UTC).", "examples": [ "2025-09-25T23:59:00" ] } }, "type": "object", "title": "AftermarketTrade", "description": "Latest extended-hours (aftermarket) trade." }, "AftermarketQuote": { "properties": { "bid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid Price", "description": "The best extended-hours bid price.", "examples": [ 245.5 ] }, "bid_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bid Size", "description": "The size available at the best bid.", "examples": [ 200 ] }, "ask_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ask Price", "description": "The best extended-hours ask price.", "examples": [ 245.9 ] }, "ask_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ask Size", "description": "The size available at the best ask.", "examples": [ 150 ] }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The cumulative extended-hours volume.", "examples": [ 1250000 ] }, "timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp", "description": "The time of the last extended-hours quote (UTC).", "examples": [ "2025-09-25T23:59:00" ] } }, "type": "object", "title": "AftermarketQuote", "description": "Latest extended-hours (aftermarket) quote." }, "AftermarketRecord": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00", "D8442A" ] }, "target_identifier_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "GOOGL", "AAPL" ] }, "trade": { "anyOf": [ { "$ref": "#/components/schemas/AftermarketTrade" }, { "type": "null" } ], "description": "The latest extended-hours trade." }, "quote": { "anyOf": [ { "$ref": "#/components/schemas/AftermarketQuote" }, { "type": "null" } ], "description": "The latest extended-hours quote." } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id" ], "title": "AftermarketRecord", "description": "Latest extended-hours trade and quote for a single entity." }, "AftermarketResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/AftermarketRecord" }, "type": "array", "title": "Results", "description": "The main data result" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "AftermarketResponse", "description": "Company aftermarket trades & quotes response model." }, "AllowedCategories": { "type": "string", "enum": [ "earnings-call", "conference-call", "ipos-calendar", "delisted-company" ], "title": "AllowedCategories" }, "AllowedPeriods": { "type": "string", "enum": [ "annual", "quarter" ], "title": "AllowedPeriods" }, "AnalystEstimates": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "The RavenPack entity ID of the company.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier ID of the company.", "examples": [ "GOOGL" ] }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields", "description": "The fields of the analyst estimates.", "examples": [ [ "FISCAL_PERIOD_END_DATE", "REVENUE_LOW", "REVENUE_HIGH", "REVENUE_AVG", "EBITDA_LOW", "EBITDA_HIGH", "EBITDA_AVG", "EBIT_LOW", "EBIT_HIGH", "EBIT_AVG", "NET_INCOME_LOW", "NET_INCOME_HIGH", "NET_INCOME_AVG", "SGA_EXPENSE_LOW", "SGA_EXPENSE_HIGH", "SGA_EXPENSE_AVG", "EPS_LOW", "EPS_HIGH", "EPS_AVG", "NUM_ANALYSTS_REVENUE", "NUM_ANALYSTS_EPS" ] ] }, "values": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "type": "array" }, "type": "array", "title": "Values", "description": "The values of the analyst estimates.", "examples": [ [ "2025-12-31", 387588929898, 399321530206, 394966067919, 135473353787, 139574231263, 138051873327, 115816555170, 119322406979, 118020938853, 118458970299, 126884966950, 121111982610, 55347517673, 57022927502, 56400969528, 9.94514, 10.19402, 9.51707, 42, 47 ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "AnalystEstimates" }, "AnalystRatings": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00", "D8442A" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "AAPL", "MSFT" ] }, "strong_buy": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Strong Buy", "description": "Number of analysts who have issued a 'Strong Buy' recommendation for the stock." }, "buy": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Buy", "description": "Number of analysts who have issued a 'Buy' rating." }, "hold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Hold", "description": "Number of analysts recommending to hold the stock." }, "sell": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sell", "description": "Number of analysts recommending to sell the stock." }, "strong_sell": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Strong Sell", "description": "Number of analysts recommending a 'Strong Sell'." }, "consensus": { "anyOf": [ { "$ref": "#/components/schemas/Consensus" }, { "type": "null" } ], "description": "The overall recommendation derived from aggregating all analyst ratings.", "examples": [ "Strong Buy", "Buy", "Hold", "Sell", "Strong Sell" ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id" ], "title": "AnalystRatings" }, "AnalystRatingsQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the analyst ratings. You must supply one type and its corresponding value." } }, "type": "object", "required": [ "identifier" ], "title": "AnalystRatingsQuery" }, "AnalystRatingsResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/AnalystRatings" }, "type": "array", "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "AnalystRatingsResponse" }, "BadRequestError": { "properties": { "statusCode": { "type": "integer", "const": 400, "title": "Statuscode", "default": 400 }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "message" ], "title": "BadRequestError", "description": "Bad Request Error", "example": { "message": "Bad Request Error", "statusCode": 400 } }, "BalanceSheet": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "The RavenPack entity ID of the company.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier ID of the company.", "examples": [ "GOOGL" ] }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields", "description": "The fields of the balance sheet.", "examples": [ [ "FISCAL_PERIOD_END_DATE", "REPORTED_CURRENCY", "CIK", "FILING_DATE", "ACCEPTED_DATE", "FISCAL_YEAR", "PERIOD", "CASH_AND_CASH_EQUIVALENTS", "SHORT_TERM_INVESTMENTS", "CASH_AND_SHORT_TERM_INVESTMENTS", "NET_RECEIVABLES", "ACCOUNTS_RECEIVABLES", "OTHER_RECEIVABLES", "INVENTORY", "PREPAIDS", "OTHER_CURRENT_ASSETS", "TOTAL_CURRENT_ASSETS", "PROPERTY_PLANT_EQUIPMENT_NET", "GOODWILL", "INTANGIBLE_ASSETS", "GOODWILL_AND_INTANGIBLE_ASSETS", "LONG_TERM_INVESTMENTS", "TAX_ASSETS", "OTHER_NON_CURRENT_ASSETS", "TOTAL_NON_CURRENT_ASSETS", "OTHER_ASSETS", "TOTAL_ASSETS", "TOTAL_PAYABLES", "ACCOUNT_PAYABLES", "OTHER_PAYABLES", "ACCRUED_EXPENSES", "SHORT_TERM_DEBT", "CAPITAL_LEASE_OBLIGATIONS_CURRENT", "TAX_PAYABLES", "DEFERRED_REVENUE", "OTHER_CURRENT_LIABILITIES", "TOTAL_CURRENT_LIABILITIES", "LONG_TERM_DEBT", "CAPITAL_LEASE_OBLIGATIONS_NON_CURRENT", "DEFERRED_REVENUE_NON_CURRENT", "DEFERRED_TAX_LIABILITIES_NON_CURRENT", "OTHER_NON_CURRENT_LIABILITIES", "TOTAL_NON_CURRENT_LIABILITIES", "OTHER_LIABILITIES", "CAPITAL_LEASE_OBLIGATIONS", "TOTAL_LIABILITIES", "TREASURY_STOCK", "PREFERRED_STOCK", "COMMON_STOCK", "RETAINED_EARNINGS", "ADDITIONAL_PAID_IN_CAPITAL", "ACCUMULATED_OTHER_COMPREHENSIVE_INCOME_LOSS", "OTHER_TOTAL_STOCKHOLDERS_EQUITY", "TOTAL_STOCKHOLDERS_EQUITY", "TOTAL_EQUITY", "MINORITY_INTEREST", "TOTAL_LIABILITIES_AND_TOTAL_EQUITY", "TOTAL_INVESTMENTS", "TOTAL_DEBT", "NET_DEBT" ] ] }, "values": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "type": "array" }, "type": "array", "title": "Values", "description": "The values of the balance sheet.", "examples": [ [ "2025-06-30", "USD", "0001652044", "2025-07-24", "2025-07-23T19:44:01", 2025, "Q2", 21036000000, 74112000000, 95148000000, 55048000000, 55048000000, 0, 0, 0, 16020000000, 166216000000, 217486000000, 32335000000, 0, 32335000000, 52574000000, 19289000000, 14153000000, 335837000000, 0, 502053000000, 9133000000, 8347000000, 786000000, 12168000000, 4107000000, 0, 786000000, 4969000000, 56933000000, 87310000000, 23607000000, 13954000000, 0, 0, 14266000000, 51827000000, 0, 11952000000, 139137000000, 0, 0, 12104000000, 275760000000, 77179000000, -2127000000, 0, 362916000000, 362916000000, 0, 502053000000, 126686000000, 41668000000, 20632000000 ], [ "2025-03-31", "USD", "0001652044", "2025-04-25", "2025-04-24T21:05:29", 2025, "Q1", 23264000000, 72064000000, 95328000000, 51000000000, 51000000000, 0, 0, 0, 15724000000, 162052000000, 198784000000, 32173000000, 0, 32173000000, 51029000000, 18386000000, 12950000000, 313322000000, 0, 475374000000, 22546000000, 8497000000, 14049000000, 46682000000, 1000000000, 0, 9773000000, 4908000000, 16518000000, 91654000000, 10886000000, 11678000000, 0, 0, 15889000000, 38453000000, 0, 11678000000, 130107000000, 0, 0, 86725000000, 262628000000, 0, -4086000000, 0, 345267000000, 345267000000, 0, 475374000000, 123093000000, 23564000000, 300000000 ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "BalanceSheet" }, "CashFlowStatement": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "The RavenPack entity ID of the company.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier ID of the company.", "examples": [ "GOOGL" ] }, "fields": { "items": { "type": "string", "enum": [ "REPORTED_CURRENCY", "CIK", "FILING_DATE", "ACCEPTED_DATE", "FISCAL_YEAR", "PERIOD", "NET_INCOME", "DEPRECIATION_AND_AMORTIZATION", "DEFERRED_INCOME_TAX", "STOCK_BASED_COMPENSATION", "CHANGE_IN_WORKING_CAPITAL", "ACCOUNTS_RECEIVABLES", "INVENTORY", "ACCOUNTS_PAYABLES", "OTHER_WORKING_CAPITAL", "OTHER_NON_CASH_ITEMS", "NET_CASH_PROVIDED_BY_OPERATING_ACTIVITIES", "INVESTMENTS_IN_PROPERTY_PLANT_AND_EQUIPMENT", "ACQUISITIONS_NET", "PURCHASES_OF_INVESTMENTS", "SALES_MATURITIES_OF_INVESTMENTS", "OTHER_INVESTING_ACTIVITIES", "NET_CASH_PROVIDED_BY_INVESTING_ACTIVITIES", "NET_DEBT_ISSUANCE", "LONG_TERM_NET_DEBT_ISSUANCE", "SHORT_TERM_NET_DEBT_ISSUANCE", "NET_STOCK_ISSUANCE", "NET_COMMON_STOCK_ISSUANCE", "COMMON_STOCK_ISSUANCE", "COMMON_STOCK_REPURCHASED", "NET_PREFERRED_STOCK_ISSUANCE", "NET_DIVIDENDS_PAID", "COMMON_DIVIDENDS_PAID", "PREFERRED_DIVIDENDS_PAID", "OTHER_FINANCING_ACTIVITIES", "NET_CASH_PROVIDED_BY_FINANCING_ACTIVITIES", "EFFECT_OF_FOREX_CHANGES_ON_CASH", "NET_CHANGE_IN_CASH", "CASH_AT_END_OF_PERIOD", "CASH_AT_BEGINNING_OF_PERIOD", "OPERATING_CASH_FLOW", "CAPITAL_EXPENDITURE", "FREE_CASH_FLOW", "INCOME_TAXES_PAID", "INTEREST_PAID" ] }, "type": "array", "title": "Fields", "description": "The fields of the cash flow statement.", "examples": [ [ "REPORTED_CURRENCY", "CIK", "FILING_DATE", "ACCEPTED_DATE", "FISCAL_YEAR", "PERIOD", "NET_INCOME", "DEPRECIATION_AND_AMORTIZATION", "DEFERRED_INCOME_TAX", "STOCK_BASED_COMPENSATION", "CHANGE_IN_WORKING_CAPITAL", "ACCOUNTS_RECEIVABLES", "INVENTORY", "ACCOUNTS_PAYABLES", "OTHER_WORKING_CAPITAL", "OTHER_NON_CASH_ITEMS", "NET_CASH_PROVIDED_BY_OPERATING_ACTIVITIES", "INVESTMENTS_IN_PROPERTY_PLANT_AND_EQUIPMENT", "ACQUISITIONS_NET", "PURCHASES_OF_INVESTMENTS", "SALES_MATURITIES_OF_INVESTMENTS", "OTHER_INVESTING_ACTIVITIES", "NET_CASH_PROVIDED_BY_INVESTING_ACTIVITIES", "NET_DEBT_ISSUANCE", "LONG_TERM_NET_DEBT_ISSUANCE", "SHORT_TERM_NET_DEBT_ISSUANCE", "NET_STOCK_ISSUANCE", "NET_COMMON_STOCK_ISSUANCE", "COMMON_STOCK_ISSUANCE", "COMMON_STOCK_REPURCHASED", "NET_PREFERRED_STOCK_ISSUANCE", "NET_DIVIDENDS_PAID", "COMMON_DIVIDENDS_PAID", "PREFERRED_DIVIDENDS_PAID", "OTHER_FINANCING_ACTIVITIES", "NET_CASH_PROVIDED_BY_FINANCING_ACTIVITIES", "EFFECT_OF_FOREX_CHANGES_ON_CASH", "NET_CHANGE_IN_CASH", "CASH_AT_END_OF_PERIOD", "CASH_AT_BEGINNING_OF_PERIOD", "OPERATING_CASH_FLOW", "CAPITAL_EXPENDITURE", "FREE_CASH_FLOW", "INCOME_TAXES_PAID", "INTEREST_PAID" ] ] }, "values": { "items": { "prefixItems": [ { "type": "string" }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "null" } ] } ], "type": "array", "maxItems": 45, "minItems": 45 }, "type": "array", "title": "Values", "description": "The values of the cash flow statement.", "examples": [ [ "USD", "0001652044", "2025-07-24", "2025-07-23T19:44:01", 2025, "Q2", 28196000000, 4998000000, -444000000, 0, -10110000000, -2839000000, 0, 553000000, -7824000000, 5107000000, 27747000000, -22446000000, -13000000, -22771000000, 21199000000, -513000000, -24544000000, 12970000000, 12970000000, 0, -13638000000, -13638000000, 0, -13638000000, 0, -2543000000, -2543000000, 0, -2621000000, -5832000000, 401000000, -2228000000, 21036000000, 23264000000, 27747000000, -22446000000, 5301000000, 0, 0 ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "CashFlowStatement" }, "CompanyRatiosTTM": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "GOOGL" ] }, "gross_profit_margin_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit Margin Ttm", "description": "Gross profit margin TTM.", "example": 0.589 }, "ebit_margin_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebit Margin Ttm", "description": "EBIT margin TTM.", "example": 0.377 }, "ebitda_margin_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebitda Margin Ttm", "description": "EBITDA margin TTM.", "example": 0.425 }, "operating_profit_margin_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Profit Margin Ttm", "description": "Operating profit margin TTM.", "example": 0.327 }, "pretax_profit_margin_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pretax Profit Margin Ttm", "description": "Pretax profit margin TTM.", "example": 0.376 }, "continuous_operations_profit_margin_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Continuous Operations Profit Margin Ttm", "description": "Continuous operations profit margin TTM.", "example": 0.311 }, "net_profit_margin_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Profit Margin Ttm", "description": "Net profit margin TTM.", "example": 0.311 }, "bottom_line_profit_margin_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bottom Line Profit Margin Ttm", "description": "Bottom line profit margin TTM.", "example": 0.311 }, "receivables_turnover_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Receivables Turnover Ttm", "description": "Receivables turnover TTM.", "example": 6.747 }, "payables_turnover_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payables Turnover Ttm", "description": "Payables turnover TTM.", "example": 18.268 }, "inventory_turnover_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inventory Turnover Ttm", "description": "Inventory turnover TTM.", "example": 0.0 }, "fixed_asset_turnover_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fixed Asset Turnover Ttm", "description": "Fixed asset turnover TTM.", "example": 1.708 }, "asset_turnover_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Asset Turnover Ttm", "description": "Asset turnover TTM.", "example": 0.74 }, "current_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Ratio Ttm", "description": "Current ratio TTM.", "example": 1.904 }, "quick_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Quick Ratio Ttm", "description": "Quick ratio TTM.", "example": 1.904 }, "solvency_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Solvency Ratio Ttm", "description": "Solvency ratio TTM.", "example": 0.958 }, "cash_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Ratio Ttm", "description": "Cash ratio TTM.", "example": 0.241 }, "price_to_earnings_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Earnings Ratio Ttm", "description": "Price-to-earnings ratio TTM.", "example": 26.708 }, "price_to_earnings_growth_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Earnings Growth Ratio Ttm", "description": "PEG ratio TTM.", "example": 5.761 }, "forward_price_to_earnings_growth_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Forward Price To Earnings Growth Ratio Ttm", "description": "Forward PEG ratio TTM.", "example": 2.066 }, "price_to_book_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Book Ratio Ttm", "description": "Price-to-book ratio TTM.", "example": 8.505 }, "price_to_sales_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Sales Ratio Ttm", "description": "Price-to-sales ratio TTM.", "example": 8.292 }, "price_to_free_cash_flow_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Free Cash Flow Ratio Ttm", "description": "Price-to-free-cash-flow ratio TTM.", "example": 46.154 }, "price_to_operating_cash_flow_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Operating Cash Flow Ratio Ttm", "description": "Price-to-operating-cash-flow ratio TTM.", "example": 23.086 }, "debt_to_assets_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Assets Ratio Ttm", "description": "Debt-to-assets ratio TTM.", "example": 0.083 }, "debt_to_equity_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Equity Ratio Ttm", "description": "Debt-to-equity ratio TTM.", "example": 0.115 }, "debt_to_capital_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Capital Ratio Ttm", "description": "Debt-to-capital ratio TTM.", "example": 0.103 }, "long_term_debt_to_capital_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Long Term Debt To Capital Ratio Ttm", "description": "Long-term debt-to-capital ratio TTM.", "example": 0.061 }, "financial_leverage_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Financial Leverage Ratio Ttm", "description": "Financial leverage ratio TTM.", "example": 1.383 }, "working_capital_turnover_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Working Capital Turnover Ratio Ttm", "description": "Working capital turnover ratio TTM.", "example": 4.975 }, "operating_cash_flow_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Ratio Ttm", "description": "Operating cash flow ratio TTM.", "example": 1.531 }, "operating_cash_flow_sales_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Sales Ratio Ttm", "description": "Operating cash flow/sales ratio TTM.", "example": 0.36 }, "free_cash_flow_operating_cash_flow_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Operating Cash Flow Ratio Ttm", "description": "FCF/OCF ratio TTM.", "example": 0.499 }, "debt_service_coverage_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt Service Coverage Ratio Ttm", "description": "Debt service coverage ratio TTM.", "example": 29.641 }, "interest_coverage_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Coverage Ratio Ttm", "description": "Interest coverage ratio TTM.", "example": 301.915 }, "short_term_operating_cash_flow_coverage_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Short Term Operating Cash Flow Coverage Ratio Ttm", "description": "Short-term OCF coverage ratio TTM.", "example": 32.556 }, "operating_cash_flow_coverage_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Coverage Ratio Ttm", "description": "Operating cash flow coverage ratio TTM.", "example": 3.209 }, "capital_expenditure_coverage_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capital Expenditure Coverage Ratio Ttm", "description": "CapEx coverage ratio TTM.", "example": 1.996 }, "dividend_paid_and_capex_coverage_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Paid And Capex Coverage Ratio Ttm", "description": "Dividend & CapEx coverage ratio TTM.", "example": 1.74 }, "dividend_payout_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Payout Ratio Ttm", "description": "Dividend payout ratio TTM.", "example": 0.085 }, "dividend_yield_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Yield Ttm", "description": "Dividend yield TTM.", "example": 0.003 }, "enterprise_value_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Enterprise Value Ttm", "description": "Enterprise value TTM.", "example": 3100393856350 }, "revenue_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue Per Share Ttm", "description": "Revenue per share TTM.", "example": 30.638 }, "net_income_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Per Share Ttm", "description": "Net income per share TTM.", "example": 9.534 }, "interest_debt_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Debt Per Share Ttm", "description": "Interest debt per share TTM.", "example": 3.471 }, "cash_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Per Share Ttm", "description": "Cash per share TTM.", "example": 7.849 }, "book_value_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Book Value Per Share Ttm", "description": "Book value per share TTM.", "example": 29.939 }, "tangible_book_value_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tangible Book Value Per Share Ttm", "description": "Tangible book value per share TTM.", "example": 27.271 }, "shareholders_equity_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shareholders Equity Per Share Ttm", "description": "Shareholders' equity per share TTM.", "example": 29.939 }, "operating_cash_flow_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Per Share Ttm", "description": "Operating cash flow per share TTM.", "example": 11.03 }, "capex_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capex Per Share Ttm", "description": "CapEx per share TTM.", "example": 5.525 }, "free_cash_flow_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Per Share Ttm", "description": "Free cash flow per share TTM.", "example": 5.505 }, "net_income_per_ebt_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Per Ebt Ttm", "description": "Net income/EBT TTM.", "example": 0.827 }, "ebt_per_ebit_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebt Per Ebit Ttm", "description": "EBT/EBIT TTM.", "example": 1.151 }, "price_to_fair_value_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Fair Value Ttm", "description": "Price-to-fair-value ratio TTM.", "example": 8.505 }, "debt_to_market_cap_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Market Cap Ttm", "description": "Debt-to-market-cap ratio TTM.", "example": 0.009 }, "effective_tax_rate_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Effective Tax Rate Ttm", "description": "Effective tax rate TTM.", "example": 0.173 }, "enterprise_value_multiple_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Enterprise Value Multiple Ttm", "description": "Enterprise value multiple TTM.", "example": 19.654 }, "dividend_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Per Share Ttm", "description": "Dividend per share TTM.", "example": 0.82 } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id" ], "title": "CompanyRatiosTTM" }, "CompanyRatiosTTMQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "An object containing the identifier value(s) and their type for the Company Ratios TTM tool." } }, "type": "object", "required": [ "identifier" ], "title": "CompanyRatiosTTMQuery" }, "CompanyRatiosTTMResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/CompanyRatiosTTM" }, "type": "array", "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "CompanyRatiosTTMResponse" }, "CompanyRevenueGeographic": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "The RavenPack entity ID of the company.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier ID of the company.", "examples": [ "GOOGL" ] }, "fields": { "items": { "type": "string", "enum": [ "FISCAL_YEAR", "PERIOD", "REPORTED_CURRENCY", "REGION_SEGMENTS" ] }, "type": "array", "title": "Fields", "description": "The fields of the company revenue geographic data.", "examples": [ [ "FISCAL_YEAR", "PERIOD", "REPORTED_CURRENCY", "REGION_SEGMENTS" ] ] }, "values": { "items": { "prefixItems": [ { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ] } ], "type": "array", "maxItems": 4, "minItems": 4 }, "type": "array", "title": "Values", "description": "The values of the company revenue geographic data.", "examples": [ [ 2025, "Q3", "USD", { "Americas Segment": 41198000000, "Europe Segment": 24014000000, "Greater China Segment": 15369000000, "Japan Segment": 5782000000, "Rest of Asia Pacific Segment": 7673000000 } ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "CompanyRevenueGeographic" }, "CompanyRevenueProduct": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "The RavenPack entity ID of the company.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier ID of the company.", "examples": [ "GOOGL" ] }, "fields": { "items": { "type": "string", "enum": [ "FISCAL_YEAR", "PERIOD", "REPORTED_CURRENCY", "PRODUCT_SEGMENTS" ] }, "type": "array", "title": "Fields", "description": "The fields of the company revenue product data.", "examples": [ [ "FISCAL_YEAR", "PERIOD", "REPORTED_CURRENCY", "PRODUCT_SEGMENTS" ] ] }, "values": { "items": { "prefixItems": [ { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ] } ], "type": "array", "maxItems": 4, "minItems": 4 }, "type": "array", "title": "Values", "description": "The values of the company revenue product data.", "examples": [ [ 2024, "FY", "USD", { "Google Cloud": 43229000000, "Google Network": 30359000000, "Google Search & Other": 198084000000, "Google Subscriptions, Platforms, And Devices": 40340000000, "Other Bets": 1648000000, "YouTube Ads": 36147000000 } ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "CompanyRevenueProduct" }, "CompanyScreenerFilters": { "properties": { "market_cap_more_than": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Market Cap More Than", "description": "Minimum market capitalization in USD.", "examples": [ 1000000000 ] }, "market_cap_lower_than": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Market Cap Lower Than", "description": "Maximum market capitalization in USD.", "examples": [ 10000000000 ] }, "price_more_than": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Price More Than", "description": "Minimum stock price in USD.", "examples": [ 10.0 ] }, "price_lower_than": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Price Lower Than", "description": "Maximum stock price in USD.", "examples": [ 200.0 ] }, "beta_more_than": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Beta More Than", "description": "Minimum beta value.", "examples": [ 0.5 ] }, "beta_lower_than": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Beta Lower Than", "description": "Maximum beta value.", "examples": [ 2.0 ] }, "volume_more_than": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Volume More Than", "description": "Minimum trading volume.", "examples": [ 1000000 ] }, "volume_lower_than": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Volume Lower Than", "description": "Maximum trading volume.", "examples": [ 10000000 ] }, "dividend_more_than": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Dividend More Than", "description": "Minimum annual dividend in USD.", "examples": [ 0.1 ] }, "dividend_lower_than": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Dividend Lower Than", "description": "Maximum annual dividend in USD.", "examples": [ 5.0 ] }, "is_etf": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Etf", "description": "Whether to include ETFs in the results.", "examples": [ false ] }, "is_fund": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Fund", "description": "Whether to include mutual funds in the results.", "examples": [ false ] }, "is_actively_trading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Actively Trading", "description": "Whether to include only actively trading stocks.", "examples": [ true ] }, "sector": { "anyOf": [ { "$ref": "#/components/schemas/Sector" }, { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "Sector of the company.", "examples": [ "Technology" ] }, "industry": { "anyOf": [ { "$ref": "#/components/schemas/Industry" }, { "type": "string" }, { "type": "null" } ], "title": "Industry", "description": "Industry of the company.", "examples": [ "Semiconductors" ] }, "country": { "anyOf": [ { "type": "string", "enum": [ "AW", "AF", "AO", "AI", "AX", "AL", "AD", "AE", "AR", "AM", "AS", "AQ", "TF", "AG", "AU", "AT", "AZ", "BI", "BE", "BJ", "BQ", "BF", "BD", "BG", "BH", "BS", "BA", "BL", "BY", "BZ", "BM", "BO", "BR", "BB", "BN", "BT", "BV", "BW", "CF", "CA", "CC", "CH", "CL", "CN", "CI", "CM", "CD", "CG", "CK", "CO", "KM", "CV", "CR", "CU", "CW", "CX", "KY", "CY", "CZ", "DE", "DJ", "DM", "DK", "DO", "DZ", "EC", "EG", "ER", "EH", "ES", "EE", "ET", "FI", "FJ", "FK", "FR", "FO", "FM", "GA", "GB", "GE", "GG", "GH", "GI", "GN", "GP", "GM", "GW", "GQ", "GR", "GD", "GL", "GT", "GF", "GU", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IM", "IN", "IO", "IE", "IR", "IQ", "IS", "IL", "IT", "JM", "JE", "JO", "JP", "KZ", "KE", "KG", "KH", "KI", "KN", "KR", "KW", "LA", "LB", "LR", "LY", "LC", "LI", "LK", "LS", "LT", "LU", "LV", "MO", "MF", "MA", "MC", "MD", "MG", "MV", "MX", "MH", "MK", "ML", "MT", "MM", "ME", "MN", "MP", "MZ", "MR", "MS", "MQ", "MU", "MW", "MY", "YT", "NA", "NC", "NE", "NF", "NG", "NI", "NU", "NL", "NO", "NP", "NR", "NZ", "OM", "PK", "PA", "PN", "PE", "PH", "PW", "PG", "PL", "PR", "KP", "PT", "PY", "PS", "PF", "QA", "RE", "RO", "RU", "RW", "SA", "SD", "SN", "SG", "GS", "SH", "SJ", "SB", "SL", "SV", "SM", "SO", "PM", "RS", "SS", "ST", "SR", "SK", "SI", "SE", "SZ", "SX", "SC", "SY", "TC", "TD", "TG", "TH", "TJ", "TK", "TM", "TL", "TO", "TT", "TN", "TR", "TV", "TW", "TZ", "UG", "UA", "UM", "UY", "US", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "ZA", "ZM", "ZW" ] }, { "type": "null" } ], "title": "Country", "description": "Country code of the company (ISO 3166-1 alpha-2).", "examples": [ "US" ] }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "Exchange code of the company.", "examples": [ "NASDAQ" ] } }, "type": "object", "title": "CompanyScreenerFilters", "description": "Filters for the company screener request." }, "CompanyScreenerQuery": { "properties": { "filters": { "anyOf": [ { "$ref": "#/components/schemas/CompanyScreenerFilters" }, { "type": "null" } ], "description": "Object specifying the filters to apply to the request.", "examples": [ { "is_actively_trading": true, "market_cap_more_than": 1000000000, "price_more_than": 10.0, "sector": "Technology" } ] }, "limit": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "title": "Limit", "description": "Maximum number of records to return (1-1000).", "default": 100, "examples": [ 100 ] } }, "type": "object", "title": "CompanyScreenerQuery", "description": "Allows filtering companies based on various financial and descriptive criteria." }, "CompanyTypes": { "type": "string", "enum": [ "PUBLIC", "PRIVATE" ], "title": "CompanyTypes" }, "CountryCode": { "type": "string", "enum": [ "SS", "NE", "BF", "GD", "ID", "NP", "BQ", "GI", "KZ", "MH", "CV", "HN", "UY", "CN", "HT", "PA", "GR", "RS", "ML", "TZ", "GS", "KN", "AW", "CF", "AM", "KR", "NU", "VC", "CD", "TL", "GM", "SC", "PK", "JP", "MP", "AU", "AQ", "GL", "US", "SK", "SN", "MX", "BG", "PG", "MY", "PN", "TO", "SD", "AR", "TD", "BV", "TW", "BH", "CY", "CK", "BN", "AS", "VE", "LT", "PW", "PR", "PM", "HK", "IM", "AL", "KI", "RW", "MC", "SG", "SL", "GU", "FK", "MV", "GH", "SO", "GY", "MQ", "KY", "GE", "CL", "VI", "CO", "BM", "JE", "DO", "PY", "MU", "SE", "CI", "TH", "MG", "BJ", "UA", "EH", "RU", "TM", "EE", "KH", "BD", "YE", "MR", "CZ", "TJ", "TN", "PH", "MS", "FM", "NG", "MO", "TV", "BR", "PF", "ZA", "MZ", "YT", "IR", "MK", "LY", "CA", "RO", "NC", "UM", "IE", "KM", "HU", "DE", "AZ", "IQ", "LK", "FJ", "BZ", "CX", "AG", "AO", "IO", "NF", "OM", "MT", "ES", "GF", "NI", "KW", "LS", "FR", "NZ", "GW", "FO", "BL", "ZM", "ET", "SI", "AI", "KE", "HR", "LA", "VG", "SA", "AX", "WS", "AF", "SR", "PL", "TF", "CW", "BE", "NO", "VN", "VA", "BB", "VU", "RE", "GQ", "DM", "CH", "LR", "ZW", "MA", "FI", "AD", "TC", "IN", "LU", "CR", "SV", "DK", "CM", "BW", "MW", "DJ", "BO", "NA", "DZ", "IT", "SY", "BY", "ER", "LB", "ME", "BS", "MF", "NL", "GT", "CC", "PT", "HM", "AE", "GG", "LC", "LV", "UZ", "BI", "BA", "BT", "GA", "SH", "MD", "JM", "SZ", "ST", "PS", "TT", "JO", "UG", "MN", "AT", "KP", "CG", "GP", "QA", "XK", "CU", "TK", "SX", "KG", "GB", "TG", "EG", "LI", "SJ", "SB", "IL", "GN", "WF", "PE", "NR", "SM", "MM", "TR", "EC", "IS" ], "title": "CountryCode" }, "CompanyProfileData": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "The RavenPack internal entity identifier.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "GOOGL" ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price", "description": "The price of the company.", "examples": [ 245.79 ] }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap", "description": "The market capitalization of the company.", "examples": [ 2972724892681 ] }, "beta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Beta", "description": "The beta of the company, i.e. the volatility of the stock.", "examples": [ 1.011 ] }, "last_dividend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Dividend", "description": "The last dividend of the company.", "examples": [ 0.0 ] }, "range": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Range", "description": "The range of the company's stock prices, e.g. '166.37-488.54'.", "examples": [ "166.37-488.54" ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "The change of the stock price of the company.", "examples": [ -1.35 ] }, "change_percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percentage", "description": "The percentage change of the stock price of company.", "examples": [ -0.54625 ] }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume", "description": "The volume of the company's stock.", "examples": [ 30515935 ] }, "average_volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Volume", "description": "The average volume of the company's stock.", "examples": [ 36559933 ] }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name", "description": "The name of the company.", "examples": [ "Alphabet Inc." ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "The currency of the company's stock.", "examples": [ "USD" ] }, "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik", "description": "The Central Index Key (CIK) of the company.", "examples": [ "0001652044" ] }, "isin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Isin", "description": "The International Securities Identification Number (ISIN) of the company.", "examples": [ "US02079K3059" ] }, "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cusip", "description": "The Committee on Uniform Securities Identification Procedures (CUSIP) of the company.", "examples": [ "02079K305" ] }, "exchange_full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange Full Name", "description": "The full name of the exchange where the company is listed.", "examples": [ "NASDAQ Global Select" ] }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The exchange where the company is listed.", "examples": [ "NASDAQ" ] }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry", "description": "The industry of the company.", "examples": [ "Internet Content & Information" ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website of the company.", "examples": [ "https://www.abc.xyz" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description of the company, e.g. 'Tesla, Inc. designs, develops, ...'", "examples": [ "Alphabet Inc. provides various products and platforms in the United States, Europe, the Middle East, Africa, the Asia-Pacific, Canada, and Latin America. It operates through Google Services, Google Cloud, and Other Bets segments. The Google Services segment offers products and services, including ads, Android, Chrome, hardware, Gmail, Google Drive, Google Maps, Google Photos, Google Play, Search, and YouTube. It is also involved in the sale of apps and in-app purchases and digital content in the Google Play store; and Fitbit wearable devices, Google Nest home products, Pixel phones, and other devices, as well as in the provision of YouTube non-advertising services. The Google Cloud segment offers infrastructure, platform, and other services; Google Workspace that include cloud-based collaboration tools for enterprises, such as Gmail, Docs, Drive, Calendar, and Meet; and other services for enterprise customers. The Other Bets segment sells health technology and internet services. The company was founded in 1998 and is headquartered in Mountain View, California." ] }, "ceo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ceo", "description": "The name of the CEO of the company.", "examples": [ "Sundar Pichai" ] }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "The sector of the company.", "examples": [ "Communication Services" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "The country where the company is located.", "examples": [ "US" ] }, "full_time_employees": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Full Time Employees", "description": "The number of full-time employees of the company", "examples": [ "185719" ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone", "description": "The phone number of the company.", "examples": [ "650 253 0000" ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "The address of the company.", "examples": [ "1600 Amphitheatre Parkway" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "The city where the company is located.", "examples": [ "Mountain View" ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "The state where the company is located.", "examples": [ "CA" ] }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip", "description": "The zip code of the company.", "examples": [ "94043" ] }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image", "description": "The image URL of the company.", "examples": [ "https://images.financialmodelingprep.com/symbol/GOOGL.png" ] }, "ipo_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string" }, { "type": "null" } ], "title": "Ipo Date", "description": "The IPO date of the company, e.g. '2010-06-29'.", "examples": [ "2004-08-19" ] }, "default_image": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Default Image", "description": "Whether the image is the default image or not.", "examples": [ false ] }, "is_etf": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Etf", "description": "Whether the company is an ETF or not.", "examples": [ false ] }, "is_actively_trading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Actively Trading", "description": "Whether the company is actively trading or not.", "examples": [ true ] }, "is_adr": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Adr", "description": "Whether the company is an ADR or not, i.e. American Depositary Receipt.", "examples": [ false ] }, "is_fund": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Fund", "description": "Whether the company is a fund or not.", "examples": [ false ] } }, "type": "object", "title": "CompanyProfileData", "description": "Company profile data model." }, "CompanyQuote": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "GOOGL" ] }, "name": { "type": "string", "title": "Name", "description": "The name of the company.", "examples": [ "Alphabet Inc." ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price", "description": "The current price of the company.", "examples": [ 245.79 ] }, "change_percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percentage", "description": "The percentage change in the price of the company.", "examples": [ -0.546 ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "The change in the price of the company.", "examples": [ -1.35 ] }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The volume of the company.", "examples": [ 30515935 ] }, "day_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Day Low", "description": "The low price of the company.", "examples": [ 240.74 ] }, "day_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Day High", "description": "The high price of the company.", "examples": [ 246.49 ] }, "year_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year High", "description": "The highest price of the company in the last year.", "examples": [ 256 ] }, "year_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year Low", "description": "The lowest price of the company in the last year.", "examples": [ 140.53 ] }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap", "description": "The market cap of the company.", "examples": [ 2972724892681 ] }, "price_avg_50": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Avg 50", "description": "The average price of the company over the last 50 days.", "examples": [ 214.116 ] }, "price_avg_200": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Avg 200", "description": "The average price of the company over the last 200 days.", "examples": [ 184.673 ] }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The exchange of the company.", "examples": [ "NASDAQ" ] }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The opening price of the company.", "examples": [ 244.165 ] }, "previous_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Previous Close", "description": "The previous closing price of the company.", "examples": [ 247.14 ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timestamp", "description": "The timestamp of the company quote.", "examples": [ "2025-09-25T20:00:00" ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "The currency of the asset.", "examples": [ "USD" ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "name", "price", "change_percentage", "change", "volume", "day_low", "day_high", "year_high", "year_low", "market_cap", "price_avg_50", "price_avg_200", "exchange", "open", "previous_close", "timestamp", "currency" ], "title": "CompanyQuote" }, "CompanyQuoteQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the quote. You must supply one type and its corresponding value." } }, "type": "object", "required": [ "identifier" ], "title": "CompanyQuoteQuery" }, "Consensus": { "type": "string", "enum": [ "Strong Buy", "Buy", "Hold", "Sell", "Strong Sell" ], "title": "Consensus", "description": "Enum for the consensus rating of analysts." }, "DailyPricesQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the daily price. You must supply one type and its corresponding value. Only one identifier should be provided per request.", "examples": [ { "type": "rp_entity_id", "value": "4A6F00" } ] }, "date_range": { "anyOf": [ { "$ref": "#/components/schemas/QueryDateRange" }, { "type": "null" } ], "description": "The date range for retrieving daily prices. All dates must be provided in the local time zone of the security exchange, and all results are returned in that same local exchange time. The expected date format is 'YYYY-MM-DD', for example, '2025-09-02'.", "examples": [ { "end": "2023-09-05", "start": "2023-09-01" } ] } }, "type": "object", "required": [ "identifier", "date_range" ], "title": "DailyPricesQuery" }, "DailyPricesResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/DailyPricesResults" }, "type": "array", "title": "Results", "description": "The main data result" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "DailyPricesResponse", "description": "Company Daily Prices response model." }, "DailyPricesResults": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00", "D8442A" ] }, "target_identifier_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "AAPL", "MSFT" ] }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields", "description": "Column names for the data values", "examples": [ [ "DATE", "OPEN", "LOW", "HIGH", "CLOSE", "VOLUME", "CHANGE", "CHANGE_PERCENT", "VWAP", "CURRENCY" ] ] }, "values": { "items": { "$ref": "#/components/schemas/DailyPricesValue" }, "type": "array", "title": "Values", "description": "Daily Prices records", "examples": [ [ "2025-09-22", 254.43, 250.3, 255.78, 252.53, 32255300, -1.9, -0.74677, 253.26, "USD" ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "DailyPricesResults", "description": "Prices for an entity id." }, "DailyPricesValue": { "prefixItems": [ { "type": "string", "format": "date" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "integer" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "type": "array", "maxItems": 10, "minItems": 10, "title": "DailyPricesValue", "description": "Represents one row of values as a tuple (or list)." }, "DateRange": { "properties": { "start": { "type": "string", "format": "date", "title": "Start", "description": "Start date for the sentiment data query (inclusive).", "examples": [ "2025-01-01" ] }, "end": { "type": "string", "format": "date", "title": "End", "description": "End date for the sentiment data query (inclusive).", "examples": [ "2025-06-30" ] } }, "type": "object", "required": [ "start", "end" ], "title": "DateRange", "description": "Date range for filtering sentiment data." }, "DateRangeFilter": { "properties": { "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start", "description": "The start of the publication time window in ISO 8601 format (e.g., '2024-01-01T00:00:00Z')." }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End", "description": "The end of the publication time window in ISO 8601 format (e.g., '2024-04-01T23:59:59Z')." } }, "type": "object", "title": "DateRangeFilter", "description": "Filters based on a time window." }, "Document": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier of the document." }, "headline": { "type": "string", "title": "Headline", "description": "The title of the document." }, "timestamp": { "type": "string", "title": "Timestamp", "description": "The publication date of the document in ISO 8601 format." }, "document_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Type", "description": "The type of the document." }, "source": { "$ref": "#/components/schemas/DocumentSource", "description": "The source of the document." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "The URL of the document." }, "chunks": { "items": { "$ref": "#/components/schemas/DocumentChunk" }, "type": "array", "title": "Chunks", "description": "A list of chunks that make up the document. Each chunk contains a part of the document's text." } }, "type": "object", "required": [ "id", "headline", "timestamp", "document_type", "source", "url" ], "title": "Document", "description": "A document that can be returned in search results." }, "DocumentChunk": { "properties": { "cnum": { "type": "integer", "title": "Cnum", "description": "The unique identifier of the chunk inside a document." }, "text": { "type": "string", "title": "Text", "description": "The text content of the chunk." }, "relevance": { "type": "number", "title": "Relevance", "description": "The relevance score of the chunk, between 0 and 1, where 1 is most relevant." } }, "type": "object", "required": [ "cnum", "text", "relevance" ], "title": "DocumentChunk", "description": "A chunk of text from a document." }, "DocumentSource": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier of the source." }, "name": { "type": "string", "title": "Name", "description": "The name of the source." } }, "type": "object", "required": [ "id", "name" ], "title": "DocumentSource", "description": "Supported document sources" }, "DocumentTypeFilter": { "properties": { "mode": { "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ], "title": "Mode" }, "values": { "items": { "type": "string", "enum": [ "FILING", "NEWS", "TRANSCRIPT", "TRANSCRIPT-PRESENTATION" ] }, "type": "array", "title": "Values" } }, "type": "object", "required": [ "mode", "values" ], "title": "DocumentTypeFilter" }, "ESGPerformanceScore": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "The RavenPack entity ID of the company.", "examples": [ "E09E2B" ] }, "name": { "type": "string", "title": "Name", "description": "The name of the company.", "examples": [ "Nvidia Corp." ] }, "ticker": { "type": "string", "title": "Ticker", "description": "The ticker symbol of the company.", "examples": [ "NVDA-NAS" ] }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry", "description": "The industry of the company.", "examples": [ "Semiconductors" ] }, "economic_sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Economic Sector", "description": "The economic sector of the company.", "examples": [ "Electronic Technology" ] }, "esg_scores": { "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "array", "title": "Esg Scores", "description": "The fields of ESG performance scores.", "examples": [ [ "YEAR", "ESG_AVERAGE_SCORE", "ENVIRONMENTAL_SCORE", "SOCIAL_SCORE", "GOVERNANCE_SCORE", "PLUS_BMI_PICC_SCORE", "PLUS_E_AQ_SCORE", "PLUS_E_EI_SCORE", "PLUS_E_GHGE_SCORE", "PLUS_E_EM_SCORE", "PLUS_E_WHMM_SCORE", "PLUS_E_WWM_SCORE", "PLUS_BMI_MSE_SCORE", "PLUS_BMI_PDLM_SCORE", "PLUS_SC_CP_SCORE", "PLUS_SC_DS_SCORE", "PLUS_SC_HRCR_SCORE", "PLUS_SC_CW_SCORE", "PLUS_SC_SPPL_SCORE", "PLUS_HC_LP_SCORE", "PLUS_HC_EHS_SCORE", "PLUS_SC_AA_SCORE", "PLUS_HC_EEDI_SCORE", "PLUS_SC_PQS_SCORE", "PLUS_BMI_BMR_SCORE", "PLUS_LG_BE_SCORE", "PLUS_LG_CB_SCORE", "PLUS_BMI_SCM_SCORE", "PLUS_LG_SRM_SCORE", "PLUS_LG_CIRM_SCORE", "PLUS_LG_MLRE_SCORE" ] ] }, "values": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "type": "array", "title": "Values", "description": "The values of the ESG performance score.", "examples": [ [ "2025", 70.01, 78.52, 64.54, 55.22, null, 44.26, 52.05, 83.63, 94.38, 77.8, 82.24, 58.72, 80.42, 90.98, 73.83, 53.67, 68.81, 44.32, 68.01, 64.39, 47.59, 55.64, 41.88, 100, 54.68, 51.74, 61.8, 37.82, 67.31, 77.03 ], [ "2024", 66.98, 74.37, 61.99, 54.59, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ] ] } }, "type": "object", "required": [ "rp_entity_id", "name", "ticker", "industry", "economic_sector", "esg_scores", "values" ], "title": "ESGPerformanceScore" }, "EmptyResponse": { "properties": {}, "type": "object", "title": "EmptyResponse" }, "EntityFilter": { "properties": { "all_of": { "anyOf": [ { "items": { "type": "string", "minLength": 1 }, "type": "array" }, { "type": "null" } ], "title": "All Of" }, "any_of": { "anyOf": [ { "items": { "type": "string", "minLength": 1 }, "type": "array" }, { "type": "null" } ], "title": "Any Of" }, "none_of": { "anyOf": [ { "items": { "type": "string", "minLength": 1 }, "type": "array" }, { "type": "null" } ], "title": "None Of" } }, "type": "object", "title": "EntityFilter" }, "ErrorDetail": { "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "type": "object", "title": "ErrorDetail" }, "EventCalendar": { "properties": { "category": { "type": "string", "title": "Category", "description": "The category of the event, such as 'earnings-call' or 'conference-call'.", "examples": [ "earnings-call" ] }, "event_datetime": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Event Datetime", "description": "The date and time of the event in ISO 8601 format (e.g., '2023-12-05T20:00:00Z'). Events whose source dates them to the day rather than to the minute, such as IPO listings and delistings, are reported at midnight UTC on that date.", "examples": [ "2024-01-25T21:00:00Z" ] }, "title": { "type": "string", "title": "Title", "description": "The title of the event, which provides a brief description of the event's content.", "examples": [ "Alphabet Inc. Q4 2023 Earnings Call" ] }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "description": "The fiscal year of the event.", "examples": [ 2023 ] }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period", "description": "The fiscal period of the event, such as 'Q1', 'Q2', etc.", "examples": [ "Q4" ] }, "rp_collection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Collection Id", "description": "The RP collection id. All RP documents can be fetched using this id. Absent for events with no document behind them, such as IPO listings and delistings.", "examples": [ "20c4436bf8627400ad58f73dde7f2a6f" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The date and time when the event data was last updated, in ISO 8601 format (e.g., '2024-02-27T09:35:45Z').", "examples": [ "2024-01-20T14:30:15Z" ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "The date and time when the event data was created, in ISO 8601 format (e.g., '2023-11-15T08:14:26Z').", "examples": [ "2023-11-15T08:14:26Z" ] }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker", "description": "The ticker the company trades, or traded, under. IPO listings and delistings only.", "examples": [ "RBLX" ] }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name", "description": "The company name as the source reports it. IPO listings and delistings only.", "examples": [ "Roblox Corporation" ] }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The exchange the company listed on, or was delisted from, as the source names it (e.g. 'NASDAQ'). IPO listings and delistings only. This is the source's own name, not a MIC code, and neither category can be filtered by exchange at all: setting the 'exchanges' request filter excludes both from the response.", "examples": [ "NYSE" ] } }, "type": "object", "required": [ "category", "title" ], "title": "EventCalendar" }, "EventsCalendarQuery": { "properties": { "rp_entity_id": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "A list of RavenPack internal entity identifiers. Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (4A6F00)", "examples": [ "4A6F00", "D8442A" ] }, "start_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date", "description": "The start date of the time range for retrieving events. Only events occurring on or after this date will be included. The expected date format is 'YYYY-MM-DD'.", "examples": [ "2025-09-02" ] }, "end_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date", "description": "The end date of the time range for retrieving events. Only events occurring on or before this date will be included. The expected date format is 'YYYY-MM-DD'.", "examples": [ "2025-09-03" ] }, "countries": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Countries", "description": "A list of country codes (ISO 3166-1 alpha-2) to filter events by country. If omitted, events from all countries will be returned. The IPO and delisted calendars cover US companies only, so 'ipos-calendar' and 'delisted-company' events are included when the country list is omitted or empty, or when 'US' is included in the list.", "examples": [ "US", "GB" ] }, "exchanges": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exchanges", "description": "Exchange code(s) to filter events by. Accepts MIC codes (ISO 10383, e.g. 'XNYS', 'XNGS'). Accepts a single exchange or a list. Setting this filter excludes 'ipos-calendar' and 'delisted-company' events from the response entirely - both report exchanges as free text rather than MIC codes, so neither can honour the filter.", "examples": [ "XNYS", "XNCM", "XNGS" ] }, "categories": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AllowedCategories" }, "type": "array" }, { "type": "null" } ], "title": "Categories", "description": "A list of event categories to filter by. Events covered: 'earnings-call', 'conference-call', 'ipos-calendar', 'delisted-company'. IPO listings and delistings are US-only, and the 'cursor' and 'exchanges' filters do not apply to either. If omitted, every category your organization has access to is returned. Note that every delisting is in the past, so a forward-looking window matches none of them. 'delisted-company' covers delistings from 2025-01-01 onwards; naming it with an 'end_date' before that returns 422 rather than an empty calendar, and naming it without a 'start_date' returns every delisting from 2025-01-01 to your 'end_date'. Set 'start_date' to narrow that. Access to 'ipos-calendar' and 'delisted-company' is enabled per organization. A category your organization does not have is left out of the response and the rest of the request is served; a request left with no category to serve returns 403.", "examples": [ "earnings-call", "conference-call", "ipos-calendar", "delisted-company" ] }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor", "description": "The cursor for pagination. Use the 'cursor' value from the previous response's pagination to get the next set of results.", "examples": [ "375207" ] }, "limit": { "anyOf": [ { "type": "integer", "maximum": 1000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Limit", "description": "The number of results to return per page. Must be between 1 and 1000, both inclusive. It bounds the transcript events a page pages through; IPO listings are returned alongside them, so a page can carry more events than the limit.", "examples": [ 100 ] } }, "type": "object", "title": "EventsCalendarQuery", "example": { "categories": [ "earnings-call", "conference-call", "ipos-calendar", "delisted-company" ], "end_date": "2024-02-15", "start_date": "2024-01-01" } }, "EventsCalendarResponse": { "properties": { "results": { "additionalProperties": { "items": { "$ref": "#/components/schemas/EventCalendar" }, "type": "array" }, "type": "object", "title": "Results", "description": "A dictionary mapping RP entity IDs to lists of event calendar entries for each company. Only events whose company has an rp_entity_id appear here; the rest are in 'events_unmapped', so read both to get the whole calendar." }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] }, "pagination": { "anyOf": [ { "$ref": "#/components/schemas/Pagination" }, { "type": "null" } ] }, "events_unmapped": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EventCalendar" }, "type": "array" }, { "type": "null" } ], "title": "Events Unmapped", "description": "Events whose company has not been mapped to an rp_entity_id appear here instead of in 'results'. For an IPO listing this reflects a temporary state in the mapping process: once the company begins trading and mapping completes, the event moves into 'results'. A delisted company may instead never have been mapped. Identify these events by 'ticker' and 'company_name'." } }, "type": "object", "required": [ "results" ], "title": "EventsCalendarResponse", "example": { "events_unmapped": [ { "category": "ipos-calendar", "company_name": "AppMedia Inc.", "event_datetime": "2024-02-01T00:00:00Z", "exchange": "NASDAQ", "ticker": "APMD", "title": "AppMedia Inc. (APMD) Set to List on NASDAQ on 2024-02-01" } ], "pagination": { "cursor": "375207", "has_cursor": true }, "results": { "4A6F00": [ { "category": "earnings-call", "created_at": "2023-11-15T08:14:26Z", "event_datetime": "2024-01-25T21:00:00Z", "fiscal_period": "Q4", "fiscal_year": 2023, "rp_collection_id": "20c4436bf8627400ad58f73dde7f2a6f", "title": "Alphabet Inc. Q4 2023 Earnings Call", "updated_at": "2024-01-20T14:30:15Z" }, { "category": "conference-call", "created_at": "2024-01-05T12:00:00Z", "event_datetime": "2024-02-15T16:00:00Z", "fiscal_year": 2024, "rp_collection_id": "e25cae2fa959ff596c54ee5589de2f9b", "title": "Alphabet Inc. Investor Day 2024", "updated_at": "2024-02-10T09:15:30Z" } ], "D8442A": [ { "category": "earnings-call", "created_at": "2023-12-20T10:30:45Z", "event_datetime": "2024-01-31T17:00:00Z", "fiscal_period": "Q1", "fiscal_year": 2024, "rp_collection_id": "cda8c9e70e436107b6bae880e1c80603", "title": "Apple Inc. Q1 2024 Earnings Call", "updated_at": "2024-01-25T11:45:20Z" } ] } } }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HoldingField": { "type": "string", "enum": [ "RANK", "RP_ENTITY_ID", "WSR_ENTITY_ID", "TICKER", "NAME", "ACTIVE", "MARKET_VALUE", "STATUS", "PORTFOLIO_WEIGHT", "SHARES", "SHARES_LAST", "SHARES_CHANGE", "SHARES_CHANGE_PERCENT", "CAPITAL_FLOW", "REPORTING_YEAR", "REPORTING_QUARTER" ], "title": "HoldingField" }, "HoldingRow": { "prefixItems": [ { "type": "integer" }, { "type": "string" }, { "type": "string" }, { "type": "string" }, { "type": "string" }, { "type": "boolean" }, { "type": "integer" }, { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "integer" }, { "type": "integer" }, { "type": "number" }, { "type": "integer" }, { "type": "integer" }, { "type": "integer" } ], "type": "array", "maxItems": 16, "minItems": 16, "title": "HoldingRow", "description": "Represents one row of intraday price data as a tuple, this is the structure:\n- [0] int: Rank\n- [1] str: RavenPack Entity ID\n- [2] str: Wall Street Rank Entity ID (Ticker)\n- [3] str: Ticker\n- [4] str: Name\n- [5] bool: Active\n- [6] int: Market Value\n- [7] str: Status\n- [8] RoundedFloat: Portfolio Weight\n- [9] int: Shares\n- [10] int: Shares Last\n- [11] int: Shares Change\n- [12] RoundedFloat: Shares Change Percent\n- [13] int: Capital Flow\n- [14] int: Reporting Year\n- [15] int: Reporting Quarter\nExample:\n [1, \"D8442A\", \"AAPL\", \"AAPL\", \"Apple\", true, 253273263449, \"increased\", 5.319, 1140202870, 1123417607, 16785263, 1.49, 3728510470, 2025, 1]" }, "HoldingStatus": { "type": "string", "enum": [ "new", "increased", "maintained", "reduced", "closed" ], "title": "HoldingStatus" }, "Identifier": { "properties": { "type": { "$ref": "#/components/schemas/IdentifierType", "description": "The identifier namespace. Currently only `rp_entity_id` is supported.", "default": "rp_entity_id", "examples": [ "rp_entity_id" ] }, "value": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Value", "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)", "examples": [ "4A6F00" ] } }, "type": "object", "required": [ "type", "value" ], "title": "Identifier" }, "IdentifierQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the company profile. You must supply one type and its corresponding value." } }, "type": "object", "required": [ "identifier" ], "title": "IdentifierQuery" }, "IdentifierType": { "type": "string", "enum": [ "rp_entity_id" ], "title": "IdentifierType", "default": "rp_entity_id" }, "IncomeStatement": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "The RavenPack entity ID of the company.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier ID of the company.", "examples": [ "GOOGL" ] }, "fields": { "items": { "type": "string", "enum": [ "FISCAL_PERIOD_END_DATE", "REPORTED_CURRENCY", "CIK", "FILING_DATE", "ACCEPTED_DATE", "FISCAL_YEAR", "PERIOD", "REVENUE", "COST_OF_REVENUE", "GROSS_PROFIT", "RESEARCH_AND_DEVELOPMENT_EXPENSES", "GENERAL_AND_ADMINISTRATIVE_EXPENSES", "SELLING_AND_MARKETING_EXPENSES", "SELLING_GENERAL_AND_ADMINISTRATIVE_EXPENSES", "OTHER_EXPENSES", "OPERATING_EXPENSES", "COST_AND_EXPENSES", "NET_INTEREST_INCOME", "INTEREST_INCOME", "INTEREST_EXPENSE", "DEPRECIATION_AND_AMORTIZATION", "EBITDA", "EBIT", "NON_OPERATING_INCOME_EXCLUDING_INTEREST", "OPERATING_INCOME", "TOTAL_OTHER_INCOME_EXPENSES_NET", "INCOME_BEFORE_TAX", "INCOME_TAX_EXPENSE", "NET_INCOME_FROM_CONTINUING_OPERATIONS", "NET_INCOME_FROM_DISCONTINUED_OPERATIONS", "OTHER_ADJUSTMENTS_TO_NET_INCOME", "NET_INCOME", "NET_INCOME_DEDUCTIONS", "BOTTOM_LINE_NET_INCOME", "EPS", "EPS_DILUTED", "WEIGHTED_AVERAGE_SHS_OUT", "WEIGHTED_AVERAGE_SHS_OUT_DIL" ] }, "type": "array", "title": "Fields", "description": "The fields of the income statement (fixed list).", "examples": [ [ "FISCAL_PERIOD_END_DATE", "REPORTED_CURRENCY", "CIK", "FILING_DATE", "ACCEPTED_DATE", "FISCAL_YEAR", "PERIOD", "REVENUE", "COST_OF_REVENUE", "GROSS_PROFIT", "RESEARCH_AND_DEVELOPMENT_EXPENSES", "GENERAL_AND_ADMINISTRATIVE_EXPENSES", "SELLING_AND_MARKETING_EXPENSES", "SELLING_GENERAL_AND_ADMINISTRATIVE_EXPENSES", "OTHER_EXPENSES", "OPERATING_EXPENSES", "COST_AND_EXPENSES", "NET_INTEREST_INCOME", "INTEREST_INCOME", "INTEREST_EXPENSE", "DEPRECIATION_AND_AMORTIZATION", "EBITDA", "EBIT", "NON_OPERATING_INCOME_EXCLUDING_INTEREST", "OPERATING_INCOME", "TOTAL_OTHER_INCOME_EXPENSES_NET", "INCOME_BEFORE_TAX", "INCOME_TAX_EXPENSE", "NET_INCOME_FROM_CONTINUING_OPERATIONS", "NET_INCOME_FROM_DISCONTINUED_OPERATIONS", "OTHER_ADJUSTMENTS_TO_NET_INCOME", "NET_INCOME", "NET_INCOME_DEDUCTIONS", "BOTTOM_LINE_NET_INCOME", "EPS", "EPS_DILUTED", "WEIGHTED_AVERAGE_SHS_OUT", "WEIGHTED_AVERAGE_SHS_OUT_DIL" ] ] }, "values": { "items": { "prefixItems": [ { "type": "string" }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] }, { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ] } ], "type": "array", "maxItems": 38, "minItems": 38 }, "type": "array", "title": "Values", "description": "The values of the income statement.", "examples": [ [ "2025-06-30", "USD", "0001652044", "2025-07-24", "2025-07-23T19:44:01", 2025, "Q2", 96428000000, 39039000000, 57389000000, 13808000000, 5209000000, 7101000000, 12310000000, 0, 26118000000, 65157000000, 789000000, 1050000000, 261000000, 4998000000, 39192000000, 34194000000, -2811000000, 31271000000, 2662000000, 33933000000, 5737000000, 28196000000, 0, 0, 28196000000, 0, 28196000000, 2.33, 2.31, 12122000000, 12198000000 ], [ "2025-03-31", "USD", "0001652044", "2025-04-25", "2025-04-24T21:05:29", 2025, "Q1", 90234000000, 36361000000, 53873000000, 13556000000, 3539000000, 6172000000, 9711000000, 0, 23267000000, 59628000000, 967000000, 1001000000, 34000000, 4487000000, 46310000000, 41823000000, -11217000000, 30606000000, 11183000000, 41789000000, 7249000000, 34540000000, 0, 0, 34540000000, 0, 34540000000, 2.84, 2.81, 12183000000, 12291000000 ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "IncomeStatement" }, "Industry": { "type": "string", "enum": [ "Steel", "Silver", "Other Precious Metals", "Gold", "Copper", "Aluminum", "Paper, Lumber & Forest Products", "Industrial Materials", "Construction Materials", "Chemicals - Specialty", "Chemicals", "Agricultural Inputs", "Telecommunications Services", "Internet Content & Information", "Publishing", "Broadcasting", "Advertising Agencies", "Entertainment", "Travel Lodging", "Travel Services", "Specialty Retail", "Luxury Goods", "Home Improvement", "Residential Construction", "Department Stores", "Personal Products & Services", "Leisure", "Gambling, Resorts & Casinos", "Furnishings, Fixtures & Appliances", "Restaurants", "Auto - Parts", "Auto - Manufacturers", "Auto - Recreational Vehicles", "Auto - Dealerships", "Apparel - Retail", "Apparel - Manufacturers", "Apparel - Footwear & Accessories", "Packaging & Containers", "Tobacco", "Grocery Stores", "Discount Stores", "Household & Personal Products", "Packaged Foods", "Food Distribution", "Food Confectioners", "Agricultural Farm Products", "Education & Training Services", "Beverages - Wineries & Distilleries", "Beverages - Non-Alcoholic", "Beverages - Alcoholic", "Uranium", "Solar", "Oil & Gas Refining & Marketing", "Oil & Gas Midstream", "Oil & Gas Integrated", "Oil & Gas Exploration & Production", "Oil & Gas Equipment & Services", "Oil & Gas Energy", "Oil & Gas Drilling", "Coal", "Shell Companies", "Investment - Banking & Investment Services", "Insurance - Specialty", "Insurance - Reinsurance", "Insurance - Property & Casualty", "Insurance - Life", "Insurance - Diversified", "Insurance - Brokers", "Financial - Mortgages", "Financial - Diversified", "Financial - Data & Stock Exchanges", "Financial - Credit Services", "Financial - Conglomerates", "Financial - Capital Markets", "Banks - Regional", "Banks - Diversified", "Banks", "Asset Management", "Asset Management - Bonds", "Asset Management - Income", "Asset Management - Leveraged", "Asset Management - Cryptocurrency", "Asset Management - Global", "Medical - Specialties", "Medical - Pharmaceuticals", "Medical - Instruments & Supplies", "Medical - Healthcare Plans", "Medical - Healthcare Information Services", "Medical - Equipment & Services", "Medical - Distribution", "Medical - Diagnostics & Research", "Medical - Devices", "Medical - Care Facilities", "Drug Manufacturers - Specialty & Generic", "Drug Manufacturers - General", "Biotechnology", "Waste Management", "Trucking", "Railroads", "Aerospace & Defense", "Marine Shipping", "Integrated Freight & Logistics", "Airlines, Airports & Air Services", "General Transportation", "Manufacturing - Tools & Accessories", "Manufacturing - Textiles", "Manufacturing - Miscellaneous", "Manufacturing - Metal Fabrication", "Industrial - Distribution", "Industrial - Specialties", "Industrial - Pollution & Treatment Controls", "Environmental Services", "Industrial - Machinery", "Industrial - Infrastructure Operations", "Industrial - Capital Goods", "Consulting Services", "Business Equipment & Supplies", "Staffing & Employment Services", "Rental & Leasing Services", "Engineering & Construction", "Security & Protection Services", "Specialty Business Services", "Construction", "Conglomerates", "Electrical Equipment & Parts", "Agricultural - Machinery", "Agricultural - Commodities/Milling", "REIT - Specialty", "REIT - Retail", "REIT - Residential", "REIT - Office", "REIT - Mortgage", "REIT - Industrial", "REIT - Hotel & Motel", "REIT - Healthcare Facilities", "REIT - Diversified", "Real Estate - Services", "Real Estate - Diversified", "Real Estate - Development", "Real Estate - General", "Information Technology Services", "Hardware, Equipment & Parts", "Computer Hardware", "Electronic Gaming & Multimedia", "Software - Services", "Software - Infrastructure", "Software - Application", "Semiconductors", "Media & Entertainment", "Communication Equipment", "Technology Distributors", "Consumer Electronics", "Renewable Utilities", "Regulated Water", "Regulated Gas", "Regulated Electric", "Independent Power Producers", "Diversified Utilities", "General Utilities" ], "title": "Industry", "description": "Industry enum for public API." }, "InputPagination": { "properties": { "limit": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "title": "Limit", "default": 100, "examples": [ 100 ] }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor", "description": "The cursor for pagination. Use the 'next' value from the previous response to get the next set of results.", "examples": [ "00000DexaRK4NT6t" ] } }, "type": "object", "title": "InputPagination" }, "InternalServerError": { "properties": { "statusCode": { "type": "integer", "const": 500, "title": "Statuscode", "default": 500 }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "message" ], "title": "InternalServerError", "description": "Internal Server Error", "example": { "message": "Internal Server Error", "statusCode": 500 } }, "IntradayPricesQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the intraday price. You must supply one type and its corresponding value. Only one identifier should be provided per request.", "examples": [ { "type": "rp_entity_id", "value": "4A6F00" } ] }, "timestamp": { "anyOf": [ { "$ref": "#/components/schemas/QueryTimestamp" }, { "type": "null" } ], "description": "The time range for retrieving intraday prices. All timestamps must be provided in the local time zone of the security exchange, and all results are returned in that same local exchange time. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-02'.", "examples": [ { "start": "2023-09-01", "end": "2023-09-02" } ] }, "interval": { "$ref": "#/components/schemas/IntradayTimeFrame", "description": "The time interval for each intraday price data point. For example, '1min', '5min', '15min', '30min', '1hour', '4hour'.", "examples": [ "15min", "30min" ] } }, "type": "object", "required": [ "identifier", "timestamp", "interval" ], "title": "IntradayPricesQuery" }, "IntradayPricesResponse": { "properties": { "results": { "$ref": "#/components/schemas/IntradayPricesResults", "description": "The main data result" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "IntradayPricesResponse", "description": "Company Intraday Prices response model." }, "DividendsQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the dividend data. You must supply one type and its corresponding value. Only one identifier should be provided per request.", "examples": [ { "type": "rp_entity_id", "value": "4A6F00" } ] }, "limit": { "anyOf": [ { "type": "integer", "maximum": 1000, "minimum": 1 }, { "type": "null" } ], "description": "The maximum number of dividend records to return per entity. Must be between 1 and 1000.", "examples": [ 100 ] } }, "type": "object", "required": [ "identifier" ], "title": "DividendsQuery" }, "DividendsResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/DividendsResults" }, "type": "array", "description": "The main data result" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "DividendsResponse", "description": "Company Dividends response model." }, "DividendsResults": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RP Entity identifier", "examples": [ "D8442A" ] }, "target_identifier_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Identifier Id", "description": "The external identifier ID, such as a symbol", "examples": [ "AAPL" ] }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields", "description": "Column names for the data values", "examples": [ [ "DATE", "DIVIDEND", "ADJ_DIVIDEND", "RECORD_DATE", "PAYMENT_DATE", "DECLARATION_DATE", "YIELD", "FREQUENCY" ] ] }, "values": { "items": { "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ] }, "type": "array" }, "type": "array", "title": "Values", "description": "Dividend records. Each array contains [date, dividend, adjDividend, recordDate, paymentDate, declarationDate, yield, frequency]", "examples": [ [ [ "2023-08-11", 0.24, 0.24, "2023-08-14", "2023-08-17", "2023-08-03", null, "Quarterly" ], [ "2023-11-10", 0.24, 0.24, "2023-11-13", "2023-11-16", "2023-11-02", null, "Quarterly" ] ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "DividendsResults" }, "IntradayPricesResults": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RP Entity identifier", "examples": [ "4A6F00" ] }, "target_identifier_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Identifier Id", "description": "The external identifier ID, such as a symbol", "examples": [ "GOOGL" ] }, "fields": { "items": { "type": "string" }, "type": "array", "title": "Fields", "description": "Column names for the data values", "examples": [ [ "TIMESTAMP", "OPEN", "LOW", "HIGH", "CLOSE", "VOLUME", "CURRENCY" ] ] }, "values": { "items": { "$ref": "#/components/schemas/IntradayPricesValue" }, "type": "array", "title": "Values", "description": "Intraday Prices records", "examples": [ [ "2025-09-15T09:30:00", 244.77, 244.66, 252.4, 249.52, 41229669, "USD" ] ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "fields", "values" ], "title": "IntradayPricesResults", "description": "Alternative result model with strongly typed records." }, "IntradayPricesValue": { "prefixItems": [ { "type": "string", "format": "date-time" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "integer" }, { "type": "string" } ], "type": "array", "maxItems": 7, "minItems": 7, "title": "IntradayPricesValue", "description": "Represents one row of values as a tuple (or list)." }, "IntradayTimeFrame": { "type": "string", "enum": [ "1min", "5min", "15min", "30min", "1hour", "4hour" ], "title": "IntradayTimeFrame" }, "KeywordFilter": { "properties": { "all_of": { "anyOf": [ { "items": { "type": "string", "minLength": 1 }, "type": "array" }, { "type": "null" } ], "title": "All Of" }, "any_of": { "anyOf": [ { "items": { "type": "string", "minLength": 1 }, "type": "array" }, { "type": "null" } ], "title": "Any Of" }, "none_of": { "anyOf": [ { "items": { "type": "string", "minLength": 1 }, "type": "array" }, { "type": "null" } ], "title": "None Of" } }, "type": "object", "title": "KeywordFilter" }, "KeyMetricsTTM": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "GOOGL" ] }, "market_cap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Market Cap", "description": "The market cap of the company.", "examples": [ 2907172311540 ] }, "enterprise_value_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Enterprise Value Ttm", "description": "The enterprise value of the company.", "examples": [ 2907172311540 ] }, "ev_to_sales_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Sales Ttm", "description": "The EV/Sales ratio of the company.", "examples": [ 7.883 ] }, "ev_to_operating_cash_flow_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Ev To Operating Cash Flow Ttm", "description": "The EV/Operating Cash Flow ratio of the company.", "examples": [ 21.897 ] }, "ev_to_free_cash_flow_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Ev To Free Cash Flow Ttm", "description": "The EV/Free Cash Flow ratio of the company.", "examples": [ 43.876 ] }, "ev_to_ebitda_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Ev To Ebitda Ttm", "description": "The EV/EBITDA ratio of the company.", "examples": [ 18.56 ] }, "net_debt_to_ebitda_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Net Debt To Ebitda Ttm", "description": "The Net Debt/EBITDA ratio of the company.", "examples": [ 0.13 ] }, "current_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Current Ratio Ttm", "description": "The Current Ratio of the company.", "examples": [ 1.903 ] }, "income_quality_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Income Quality Ttm", "description": "The Income Quality of the company.", "examples": [ 1.156 ] }, "graham_number_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Graham Number Ttm", "description": "The Graham Number of the company.", "examples": [ 80.139 ] }, "graham_net_net_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Graham Net Net Ttm", "description": "The Graham Net Net of the company.", "examples": [ -0.222 ] }, "tax_burden_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Tax Burden Ttm", "description": "The Tax Burden of the company.", "examples": [ 0.827 ] }, "interest_burden_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Interest Burden Ttm", "description": "The Interest Burden of the company.", "examples": [ 0.997 ] }, "working_capital_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Working Capital Ttm", "description": "The Working Capital of the company.", "examples": [ 78906000000 ] }, "invested_capital_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Invested Capital Ttm", "description": "The Invested Capital of the company.", "examples": [ 328727000000 ] }, "return_on_assets_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Return On Assets Ttm", "description": "The Return on Assets of the company.", "examples": [ 0.23 ] }, "operating_return_on_assets_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Operating Return On Assets Ttm", "description": "The Operating Return on Assets of the company.", "examples": [ 0.248 ] }, "return_on_tangible_assets_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Return On Tangible Assets Ttm", "description": "The Return on Tangible Assets of the company.", "examples": [ 0.246 ] }, "return_on_equity_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Return On Equity Ttm", "description": "The Return on Equity of the company.", "examples": [ 0.343 ] }, "return_on_invested_capital_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Return On Invested Capital Ttm", "description": "The Return on Invested Capital of the company.", "examples": [ 0.239 ] }, "return_on_capital_employed_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Return On Capital Employed Ttm", "description": "The Return on Capital Employed of the company.", "examples": [ 0.292 ] }, "earnings_yield_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Earnings Yield Ttm", "description": "The Earnings Yield of the company.", "examples": [ 0.039 ] }, "free_cash_flow_yield_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Free Cash Flow Yield Ttm", "description": "The Free Cash Flow Yield of the company.", "examples": [ 0.022 ] }, "capex_to_operating_cash_flow_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Capex To Operating Cash Flow Ttm", "description": "The Capex to Operating Cash Flow of the company.", "examples": [ 0.5 ] }, "capex_to_depreciation_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Capex To Depreciation Ttm", "description": "The Capex to Depreciation of the company.", "examples": [ 3.789 ] }, "capex_to_revenue_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Capex To Revenue Ttm", "description": "The Capex to Revenue of the company.", "examples": [ 0.18 ] }, "sales_general_and_admin_to_revenue_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Sales General And Admin To Revenue Ttm", "description": "The Sales General and Admin to Revenue of the company.", "examples": [ 0.045 ] }, "research_and_development_to_revenue_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Research And Development To Revenue Ttm", "description": "The Research and Development to Revenue of the company.", "examples": [ 0.142 ] }, "stock_based_compensation_to_revenue_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Stock Based Compensation To Revenue Ttm", "description": "The Stock Based Compensation to Revenue of the company.", "examples": [ 0.046 ] }, "intangibles_to_total_assets_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Intangibles To Total Assets Ttm", "description": "The Intangibles to Total Assets of the company.", "examples": [ 0.064 ] }, "average_receivables_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Average Receivables Ttm", "description": "The Average Receivables of the company.", "examples": [ 53024000000 ] }, "average_payables_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Average Payables Ttm", "description": "The Average Payables of the company.", "examples": [ 8422000000 ] }, "average_inventory_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Average Inventory Ttm", "description": "The Average Inventory of the company.", "examples": [ 0 ] }, "days_of_sales_outstanding_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Days Of Sales Outstanding Ttm", "description": "The Days of Sales Outstanding of the company.", "examples": [ 54.099 ] }, "days_of_payables_outstanding_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Days Of Payables Outstanding Ttm", "description": "The Days of Payables Outstanding of the company.", "examples": [ 19.978 ] }, "days_of_inventory_outstanding_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Days Of Inventory Outstanding Ttm", "description": "The Days of Inventory Outstanding of the company.", "examples": [ 0 ] }, "operating_cycle_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Operating Cycle Ttm", "description": "The Operating Cycle of the company.", "examples": [ 54.099 ] }, "cash_conversion_cycle_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Cash Conversion Cycle Ttm", "description": "The Cash Conversion Cycle of the company.", "examples": [ 34.119784543416905 ] }, "free_cash_flow_to_equity_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Free Cash Flow To Equity Ttm", "description": "The Free Cash Flow to Equity of the company.", "examples": [ 46096000000 ] }, "free_cash_flow_to_firm_ttm": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Free Cash Flow To Firm Ttm", "description": "The Free Cash Flow to Firm of the company.", "examples": [ 58092641321.391 ] }, "tangible_asset_value_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tangible Asset Value Ttm", "description": "The Tangible Asset Value of the company.", "examples": [ 330581000000 ] }, "net_current_asset_value_ttm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Current Asset Value Ttm", "description": "The Net Current Asset Value of the company.", "examples": [ 27079000000 ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id" ], "title": "KeyMetricsTTM" }, "KeyMetricsTTMQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "An object containing the identifier value(s) and their type for the Key Metrics TTM tool." } }, "type": "object", "required": [ "identifier" ], "title": "KeyMetricsTTMQuery" }, "KeyMetricsTTMResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/KeyMetricsTTM" }, "type": "array", "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "KeyMetricsTTMResponse" }, "LatestSurprise": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "GOOGL" ] }, "reporting_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Reporting Date", "description": "The end date of the fiscal period.", "examples": [ "2025-07-23" ] }, "eps_actual": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps Actual", "description": "The actual EPS of the company.", "examples": [ 2.31 ] }, "eps_estimated": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps Estimated", "description": "The estimated EPS of the company.", "examples": [ 2.15 ] }, "revenue_actual": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue Actual", "description": "The actual revenue of the company.", "examples": [ 96428000000 ] }, "revenue_estimated": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue Estimated", "description": "The estimated revenue of the company.", "examples": [ 99697450760 ] }, "last_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Updated", "description": "The last updated date of the data.", "examples": [ "2025-09-16" ] }, "eps_surprise_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps Surprise Pct", "description": "The surprise percentage of the EPS.", "examples": [ 7.441 ] }, "revenue_surprise_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue Surprise Pct", "description": "The surprise percentage of the revenue.", "examples": [ -3.379 ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id" ], "title": "LatestSurprise" }, "LatestSurpriseQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the financial latest surprise. You must supply one type and its corresponding value." } }, "type": "object", "required": [ "identifier" ], "title": "LatestSurpriseQuery" }, "LatestSurpriseResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/LatestSurprise" }, "type": "array", "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "LatestSurpriseResponse" }, "MarketCap": { "type": "string", "enum": [ "mega_cap", "large_cap", "mid_cap", "small_cap", "micro_cap" ], "title": "MarketCap", "description": "Enum for market capitalization values." }, "Metadata": { "properties": { "request_id": { "type": "string", "title": "Request Id" }, "timestamp": { "type": "string", "title": "Timestamp" } }, "type": "object", "required": [ "request_id" ], "title": "Metadata" }, "Pagination-Input": { "properties": { "limit": { "anyOf": [ { "type": "integer", "maximum": 1000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Limit", "description": "The number of results to return." }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 16, "minLength": 16 }, { "type": "null" } ], "title": "Cursor", "description": "Identifier for getting next pages when using the `limit` parameter." } }, "type": "object", "title": "Pagination", "description": "Common pagination parameters for endpoints that support pagination." }, "Pagination-Output": { "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor", "description": "Next page token or URL to retrieve the next page of results.", "examples": [ "00000DexaRK4NT6t" ] }, "has_cursor": { "type": "boolean", "title": "Has Cursor", "description": "Whether there are more pages available after this one.", "default": false, "examples": [ true ] } }, "type": "object", "title": "Pagination", "description": "Common pagination response for endpoints that support pagination." }, "PriceChanges": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "GOOGL" ] }, "1D": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "1D", "description": "The price change in the last 1 day.", "examples": [ -0.546 ] }, "5D": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "5D", "description": "The price change in the last 5 days.", "examples": [ -2.946 ] }, "1M": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "1M", "description": "The price change in the last 1 month.", "examples": [ 18.659 ] }, "3M": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "3M", "description": "The price change in the last 3 months.", "examples": [ 41.633 ] }, "6M": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "6M", "description": "The price change in the last 6 months.", "examples": [ 48.909 ] }, "ytd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ytd", "description": "The price change in the last year to date.", "examples": [ 29.752 ] }, "1Y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "1Y", "description": "The price change in the last 1 year.", "examples": [ 51.042 ] }, "3Y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "3Y", "description": "The price change in the last 3 years.", "examples": [ 150.372 ] }, "5Y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "5Y", "description": "The price change in the last 5 years.", "examples": [ 237.022 ] }, "10Y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "10Y", "description": "The price change in the last 10 years.", "examples": [ 687.536 ] }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max", "description": "The price change in the last max years.", "examples": [ 9692.43 ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id", "1D", "5D", "1M", "3M", "6M", "ytd", "1Y", "3Y", "5Y", "10Y", "max" ], "title": "PriceChanges" }, "PriceChangesQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the price changes. You must supply one type and its corresponding value." } }, "type": "object", "required": [ "identifier" ], "title": "PriceChangesQuery" }, "PublicAnalystEstimatesQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the analyst estimates. You must supply one type and its corresponding value." }, "period": { "$ref": "#/components/schemas/AllowedPeriods", "description": "Select whether the estimates to be provided are on an annual or quarterly basis.", "default": "quarter", "examples": [ "annual" ] }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "description": "Maximum number of analyst estimates to return. If omitted, all analyst estimates are returned.", "default": 20, "examples": [ 20 ] } }, "type": "object", "required": [ "identifier" ], "title": "PublicAnalystEstimatesQuery" }, "PublicAnalystEstimatesResponse": { "properties": { "results": { "$ref": "#/components/schemas/AnalystEstimates" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicAnalystEstimatesResponse" }, "PublicBalanceSheetQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the balance sheet. You must supply one type and its corresponding value." }, "period": { "$ref": "#/components/schemas/AllowedPeriods", "description": "Select whether the balance sheet to be provided are on an annual or quarterly basis.", "default": "quarter", "examples": [ "annual" ] }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "description": "Maximum number of balance sheets to return. If omitted, all balance sheets are returned.", "default": 20, "examples": [ 20 ] } }, "type": "object", "required": [ "identifier" ], "title": "PublicBalanceSheetQuery" }, "PublicBalanceSheetResponse": { "properties": { "results": { "$ref": "#/components/schemas/BalanceSheet" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicBalanceSheetResponse" }, "PublicCompanyProfileResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/CompanyProfileData" }, "type": "array", "title": "Results", "description": "Company profile data keyed by RP entity ID", "examples": [ [ { "address": "1600 Amphitheatre Parkway", "average_volume": 36559933.0, "beta": 1.011, "ceo": "Sundar Pichai", "change": 0.75, "change_percentage": 0.30514, "cik": "0001652044", "city": "Mountain View", "company_name": "Alphabet Inc.", "country": "US", "currency": "USD", "cusip": "02079K305", "default_image": false, "description": "Alphabet Inc. provides various products and platforms in the United States, Europe, the Middle East, Africa, the Asia-Pacific, Canada, and Latin America. It operates through Google Services, Google Cloud, and Other Bets segments. The Google Services segment offers products and services, including ads, Android, Chrome, hardware, Gmail, Google Drive, Google Maps, Google Photos, Google Play, Search, and YouTube. It is also involved in the sale of apps and in-app purchases and digital content in the Google Play store; and Fitbit wearable devices, Google Nest home products, Pixel phones, and other devices, as well as in the provision of YouTube non-advertising services. The Google Cloud segment offers infrastructure, platform, and other services; Google Workspace that include cloud-based collaboration tools for enterprises, such as Gmail, Docs, Drive, Calendar, and Meet; and other services for enterprise customers. The Other Bets segment sells health technology and internet services. The company was founded in 1998 and is headquartered in Mountain View, California.", "exchange": "NASDAQ", "exchange_full_name": "NASDAQ Global Select", "full_time_employees": 185719, "image": "https://images.financialmodelingprep.com/symbol/GOOGL.png", "industry": "Internet Content & Information", "ipo_date": "2004-08-19", "is_actively_trading": true, "is_adr": false, "is_etf": false, "is_fund": false, "isin": "US02079K3059", "market_cap": 2981795821806.0, "phone": "650 253 0000", "price": 246.54, "range": "140.53-256", "rp_entity_id": "4A6F00", "sector": "Communication Services", "state": "CA", "target_identifier_id": "GOOGL", "volume": 18503194.0, "website": "https://www.abc.xyz", "zip": "94043" } ] ] } }, "type": "object", "required": [ "results" ], "title": "PublicCompanyProfileResponse", "description": "Response model for company profile query." }, "PublicCompanyQuoteResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/CompanyQuote" }, "type": "array", "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicCompanyQuoteResponse" }, "PublicCompanyRevenueGeographicQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the company revenue geographic data. You must supply one type and its corresponding value.", "examples": [ { "type": "rp_entity_id", "value": "D8442A" } ] }, "period": { "$ref": "#/components/schemas/AllowedPeriods", "description": "Select whether the company revenue geographic data to be provided are on an annual or quarterly basis.", "default": "quarter", "examples": [ "quarter" ] } }, "type": "object", "required": [ "identifier" ], "title": "PublicCompanyRevenueGeographicQuery" }, "PublicCompanyRevenueGeographicResponse": { "properties": { "results": { "anyOf": [ { "$ref": "#/components/schemas/CompanyRevenueGeographic" }, { "additionalProperties": true, "type": "object" } ], "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicCompanyRevenueGeographicResponse" }, "PublicCompanyRevenueProductQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the company revenue product data. You must supply one type and its corresponding value.", "examples": [ { "type": "rp_entity_id", "value": "4A6F00" } ] }, "period": { "$ref": "#/components/schemas/AllowedPeriods", "description": "Select whether the company revenue product data to be provided are on an annual or quarterly basis.", "default": "quarter", "examples": [ "annual" ] } }, "type": "object", "required": [ "identifier" ], "title": "PublicCompanyRevenueProductQuery" }, "PublicCompanyRevenueProductResponse": { "properties": { "results": { "anyOf": [ { "$ref": "#/components/schemas/CompanyRevenueProduct" }, { "additionalProperties": true, "type": "object" } ], "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicCompanyRevenueProductResponse" }, "PublicESGPerformanceScoreResponse": { "properties": { "results": { "anyOf": [ { "$ref": "#/components/schemas/ESGPerformanceScore" }, { "$ref": "#/components/schemas/EmptyResponse" } ], "title": "Results" } }, "type": "object", "required": [ "results" ], "title": "PublicESGPerformanceScoreResponse" }, "PublicCompanyScreenerResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/ScreenedCompany" }, "type": "array", "title": "Results", "description": "List of companies matching the screening criteria." }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicCompanyScreenerResponse", "description": "Response model for the Company Screener service." }, "PublicCashFlowResponse": { "properties": { "results": { "anyOf": [ { "$ref": "#/components/schemas/CashFlowStatement" }, { "items": { "$ref": "#/components/schemas/CashFlowStatement" }, "type": "array" } ], "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicCashFlowResponse" }, "PublicCashFlowStatementQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the cash flow statement. You must supply one type and its corresponding value.", "examples": [ { "type": "rp_entity_id", "value": "4A6F00" } ] }, "period": { "$ref": "#/components/schemas/AllowedPeriods", "description": "Select whether the cash flow statement to be provided are on an annual or quarterly basis.", "default": "quarter", "examples": [ "annual" ] }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "description": "Maximum number of cash flow statements records to return. If omitted, all cash flow statements records are returned.", "default": 20, "examples": [ 20 ] } }, "type": "object", "required": [ "identifier" ], "title": "PublicCashFlowStatementQuery" }, "PublicPriceChangesResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/PriceChanges" }, "type": "array", "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicPriceChangesResponse" }, "PublicNetCallsItem": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack entity ID", "examples": [ "D8442A" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "Ticker symbol", "examples": [ "AAPL" ] }, "name": { "type": "string", "title": "Name", "description": "Company name", "examples": [ "Apple Inc." ] }, "active": { "type": "boolean", "title": "Active", "description": "Whether the company is active", "examples": [ true ] }, "net_calls": { "type": "integer", "title": "Net Calls", "description": "Net calls amount", "examples": [ 5000 ] }, "calls": { "type": "integer", "title": "Calls", "description": "Total calls amount", "examples": [ 10000 ] }, "puts": { "type": "integer", "title": "Puts", "description": "Total puts amount", "examples": [ 5000 ] } }, "type": "object", "required": [ "target_identifier_id", "name", "active", "net_calls", "calls", "puts" ], "title": "PublicNetCallsItem", "description": "Item for net calls trend." }, "PublicNetClosedPositionsItem": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack entity ID", "examples": [ "D8442A" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "Ticker symbol", "examples": [ "AAPL" ] }, "name": { "type": "string", "title": "Name", "description": "Company name", "examples": [ "Apple Inc." ] }, "active": { "type": "boolean", "title": "Active", "description": "Whether the company is active", "examples": [ true ] }, "net_closed_positions": { "type": "integer", "title": "Net Closed Positions", "description": "Net closed positions count", "examples": [ 15 ] }, "new_positions": { "type": "integer", "title": "New Positions", "description": "Number of new positions", "examples": [ 20 ] }, "closed_positions": { "type": "integer", "title": "Closed Positions", "description": "Number of closed positions", "examples": [ 35 ] } }, "type": "object", "required": [ "target_identifier_id", "name", "active", "net_closed_positions", "new_positions", "closed_positions" ], "title": "PublicNetClosedPositionsItem", "description": "Item for net closed positions trend." }, "PublicNetIncreasedPositionsItem": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack entity ID", "examples": [ "D8442A" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "Ticker symbol", "examples": [ "AAPL" ] }, "name": { "type": "string", "title": "Name", "description": "Company name", "examples": [ "Apple Inc." ] }, "active": { "type": "boolean", "title": "Active", "description": "Whether the company is active", "examples": [ true ] }, "net_increased_positions": { "type": "integer", "title": "Net Increased Positions", "description": "Net increased positions count", "examples": [ 40 ] }, "increased_positions": { "type": "integer", "title": "Increased Positions", "description": "Number of increased positions", "examples": [ 60 ] }, "reduced_positions": { "type": "integer", "title": "Reduced Positions", "description": "Number of reduced positions", "examples": [ 20 ] } }, "type": "object", "required": [ "target_identifier_id", "name", "active", "net_increased_positions", "increased_positions", "reduced_positions" ], "title": "PublicNetIncreasedPositionsItem", "description": "Item for net increased positions trend." }, "PublicNetNewPositionsItem": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack entity ID", "examples": [ "D8442A" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "Ticker symbol", "examples": [ "AAPL" ] }, "name": { "type": "string", "title": "Name", "description": "Company name", "examples": [ "Apple Inc." ] }, "active": { "type": "boolean", "title": "Active", "description": "Whether the company is active", "examples": [ true ] }, "net_new_positions": { "type": "integer", "title": "Net New Positions", "description": "Net new positions count", "examples": [ 25 ] }, "new_positions": { "type": "integer", "title": "New Positions", "description": "Number of new positions", "examples": [ 50 ] }, "closed_positions": { "type": "integer", "title": "Closed Positions", "description": "Number of closed positions", "examples": [ 25 ] } }, "type": "object", "required": [ "target_identifier_id", "name", "active", "net_new_positions", "new_positions", "closed_positions" ], "title": "PublicNetNewPositionsItem", "description": "Item for net new positions trend." }, "PublicNetPutsItem": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack entity ID", "examples": [ "D8442A" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "Ticker symbol", "examples": [ "AAPL" ] }, "name": { "type": "string", "title": "Name", "description": "Company name", "examples": [ "Apple Inc." ] }, "active": { "type": "boolean", "title": "Active", "description": "Whether the company is active", "examples": [ true ] }, "net_puts": { "type": "integer", "title": "Net Puts", "description": "Net puts amount", "examples": [ 3000 ] }, "calls": { "type": "integer", "title": "Calls", "description": "Total calls amount", "examples": [ 5000 ] }, "puts": { "type": "integer", "title": "Puts", "description": "Total puts amount", "examples": [ 8000 ] } }, "type": "object", "required": [ "target_identifier_id", "name", "active", "net_puts", "calls", "puts" ], "title": "PublicNetPutsItem", "description": "Item for net puts trend." }, "PublicNetReducedPositionsItem": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack entity ID", "examples": [ "D8442A" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "Ticker symbol", "examples": [ "AAPL" ] }, "name": { "type": "string", "title": "Name", "description": "Company name", "examples": [ "Apple Inc." ] }, "active": { "type": "boolean", "title": "Active", "description": "Whether the company is active", "examples": [ true ] }, "net_reduced_positions": { "type": "integer", "title": "Net Reduced Positions", "description": "Net reduced positions count", "examples": [ 30 ] }, "increased_positions": { "type": "integer", "title": "Increased Positions", "description": "Number of increased positions", "examples": [ 40 ] }, "reduced_positions": { "type": "integer", "title": "Reduced Positions", "description": "Number of reduced positions", "examples": [ 70 ] } }, "type": "object", "required": [ "target_identifier_id", "name", "active", "net_reduced_positions", "increased_positions", "reduced_positions" ], "title": "PublicNetReducedPositionsItem", "description": "Item for net reduced positions trend." }, "PublicPositionChangeItem": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack entity ID", "examples": [ "D8442A" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "Ticker symbol", "examples": [ "AAPL" ] }, "name": { "type": "string", "title": "Name", "description": "Company name", "examples": [ "Apple Inc." ] }, "active": { "type": "boolean", "title": "Active", "description": "Whether the company is active", "examples": [ true ] }, "current": { "type": "integer", "title": "Current", "description": "Current number of funds", "examples": [ 150 ] }, "previous": { "type": "integer", "title": "Previous", "description": "Previous number of funds", "examples": [ 120 ] }, "change": { "type": "integer", "title": "Change", "description": "Change in number of funds", "examples": [ 30 ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "Percentage change", "examples": [ 25.0 ] } }, "type": "object", "required": [ "target_identifier_id", "name", "active", "current", "previous", "change" ], "title": "PublicPositionChangeItem", "description": "Item for position change trends (calls, puts, new_positions, etc.)." }, "PublicSectorComposition": { "properties": { "sector": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Sector", "examples": [ { "id": "technology", "name": "Technology" } ] }, "percent": { "type": "number", "title": "Percent", "examples": [ 22.92 ] } }, "type": "object", "required": [ "sector", "percent" ], "title": "PublicSectorComposition" }, "HoldingsOverviewFilters": { "properties": { "year": { "type": "integer", "title": "Year", "description": "Fiscal year for the holdings data", "examples": [ 2025 ] }, "quarter": { "$ref": "#/components/schemas/Quarters", "description": "Fiscal quarter for the holdings data", "examples": [ 1 ] } }, "type": "object", "required": [ "year", "quarter" ], "title": "HoldingsOverviewFilters" }, "PublicFundTrendsMetadata": { "properties": { "reporting_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reporting Year", "description": "Reporting year", "examples": [ 2025 ] }, "reporting_quarter": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reporting Quarter", "description": "Reporting quarter", "examples": [ 1 ] }, "filters_applied": { "additionalProperties": true, "type": "object", "title": "Filters Applied", "description": "Applied filters" }, "sort_dir": { "type": "string", "title": "Sort Dir", "description": "Sort direction used", "examples": [ "desc" ] }, "mapping": { "anyOf": [ { "$ref": "#/components/schemas/HoldingsMapping" }, { "type": "null" } ], "description": "RP entity ID to ticker mapping", "examples": [ { "stock": { "4A6F00": "GOOGL", "D8442A": "AAPL" } } ] } }, "type": "object", "required": [ "sort_dir" ], "title": "PublicFundTrendsMetadata", "description": "Metadata for fund trends response." }, "PublicFundTrendsResponse": { "properties": { "results": { "$ref": "#/components/schemas/PublicFundTrendsResults" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "$ref": "#/components/schemas/PublicFundTrendsMetadata" } }, "type": "object", "required": [ "results", "metadata" ], "title": "PublicFundTrendsResponse", "description": "Main response for fund trends aggregated endpoint." }, "PublicFundTrendsResults": { "properties": { "calls": { "items": { "$ref": "#/components/schemas/PublicPositionChangeItem" }, "type": "array", "title": "Calls", "description": "Calls trend data" }, "puts": { "items": { "$ref": "#/components/schemas/PublicPositionChangeItem" }, "type": "array", "title": "Puts", "description": "Puts trend data" }, "new_positions": { "items": { "$ref": "#/components/schemas/PublicPositionChangeItem" }, "type": "array", "title": "New Positions", "description": "New positions trend data" }, "closed_positions": { "items": { "$ref": "#/components/schemas/PublicPositionChangeItem" }, "type": "array", "title": "Closed Positions", "description": "Closed positions trend data" }, "increased_positions": { "items": { "$ref": "#/components/schemas/PublicPositionChangeItem" }, "type": "array", "title": "Increased Positions", "description": "Increased positions trend data" }, "reduced_positions": { "items": { "$ref": "#/components/schemas/PublicPositionChangeItem" }, "type": "array", "title": "Reduced Positions", "description": "Reduced positions trend data" }, "holding_in_top": { "items": { "$ref": "#/components/schemas/PublicPositionChangeItem" }, "type": "array", "title": "Holding In Top", "description": "Holding in top 10 trend data" }, "net_calls": { "items": { "$ref": "#/components/schemas/PublicNetCallsItem" }, "type": "array", "title": "Net Calls", "description": "Net calls trend data" }, "net_puts": { "items": { "$ref": "#/components/schemas/PublicNetPutsItem" }, "type": "array", "title": "Net Puts", "description": "Net puts trend data" }, "net_new_positions": { "items": { "$ref": "#/components/schemas/PublicNetNewPositionsItem" }, "type": "array", "title": "Net New Positions", "description": "Net new positions trend data" }, "net_closed_positions": { "items": { "$ref": "#/components/schemas/PublicNetClosedPositionsItem" }, "type": "array", "title": "Net Closed Positions", "description": "Net closed positions trend data" }, "net_increased_positions": { "items": { "$ref": "#/components/schemas/PublicNetIncreasedPositionsItem" }, "type": "array", "title": "Net Increased Positions", "description": "Net increased positions trend data" }, "net_reduced_positions": { "items": { "$ref": "#/components/schemas/PublicNetReducedPositionsItem" }, "type": "array", "title": "Net Reduced Positions", "description": "Net reduced positions trend data" } }, "type": "object", "title": "PublicFundTrendsResults", "description": "Container with all fund trends data." }, "PublicGetCompanyFundsHoldingsQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the company profile. You must supply one type and its corresponding value." }, "filters": { "anyOf": [ { "$ref": "#/components/schemas/CompanyFundsHoldingsFilters" }, { "type": "null" } ], "description": "Object specifying the filters to apply to the request.", "examples": [ { "quarter": 2, "year": 2023 } ] } }, "type": "object", "required": [ "identifier" ], "title": "PublicGetCompanyFundsHoldingsQuery", "description": "Schema for the request to the public API." }, "PublicGetCompanyFundsHoldingsResponse": { "properties": { "results": { "anyOf": [ { "$ref": "#/components/schemas/CompanyFundHoldingsResults" }, { "$ref": "#/components/schemas/EmptyResponse" } ], "title": "Results" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/PublicCompanyFundsHoldingsRequestMetadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicGetCompanyFundsHoldingsResponse" }, "CompanyFundHoldingsRow": { "properties": { "rp_entity_id": { "anyOf": [ { "type": "string", "maxLength": 6, "minLength": 6, "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)", "examples": [ "4A6F00" ] }, { "type": "null" } ], "title": "Rp Entity Id", "description": "The RavenPack entity ID of the holding.", "examples": [ "HJ95FV" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name of the holding.", "examples": [ "Blackrock" ] }, "rank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rank", "description": "The rank of the holding in the portfolio.", "examples": [ 1 ] }, "market_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Market Value", "description": "The market value of the holding.", "examples": [ 253273263449 ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "The status of the holding (e.g., increased, decreased).", "examples": [ "increased" ] }, "shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares", "description": "The number of shares held.", "examples": [ 1140202870 ] }, "shares_last": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares Last", "description": "The number of shares held in the last reporting period.", "examples": [ 1123417607 ] }, "shares_change": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares Change", "description": "The change in the number of shares held since the last reporting period.", "examples": [ 16785263 ] }, "shares_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shares Change Percent", "description": "The percentage change in the number of shares held since the last reporting period.", "examples": [ 1.49 ] }, "capital_flow": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Capital Flow", "description": "The capital flow associated with the holding.", "examples": [ 3728510470 ] } }, "type": "object", "required": [ "rp_entity_id", "name", "rank", "market_value", "status", "shares", "shares_last", "shares_change", "shares_change_percent", "capital_flow" ], "title": "CompanyFundHoldingsRow" }, "CompanyFundHoldingsResults": { "properties": { "funds": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CompanyFundHoldingsRow" }, "type": "array" }, { "type": "null" } ], "title": "Funds", "description": "List of company fund holdings." } }, "type": "object", "required": [ "funds" ], "title": "CompanyFundHoldingsResults" }, "CompanyFundsHoldingsFilters": { "properties": { "year": { "type": "integer", "title": "Year", "description": "Fiscal year for the holdings data", "examples": [ 2025 ] }, "quarter": { "$ref": "#/components/schemas/Quarters", "description": "Fiscal quarter for the holdings data" } }, "type": "object", "title": "CompanyFundsHoldingsFilters", "description": "Extended filters for stock funds holdings." }, "PublicCompanyFundsHoldingsRequestMetadata": { "properties": { "request_id": { "type": "string", "title": "Request Id", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ] }, "timestamp": { "type": "string", "title": "Timestamp", "examples": [ "2025-09-08T10:52:33.453834+00:00" ] }, "rp_entity_id": { "anyOf": [ { "type": "string", "maxLength": 6, "minLength": 6, "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)", "examples": [ "4A6F00" ] }, { "type": "null" } ], "title": "Rp Entity Id", "examples": [ "D8442A" ] }, "stock_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stock Name", "examples": [ "Apple" ] }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year", "examples": [ 2025 ] }, "quarter": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quarter", "examples": [ 1 ] } }, "type": "object", "required": [ "request_id" ], "title": "PublicCompanyFundsHoldingsRequestMetadata", "description": "Metadata for the request. Includes the backend request." }, "PublicGetFundTrendsQuery": { "properties": { "type": { "anyOf": [ { "$ref": "#/components/schemas/SecurityType" }, { "type": "null" } ], "description": "The type of securities to retrieve. One of 'stock' or 'etf'. Returns all types if not specified.", "examples": [ "stock" ] }, "market_cap": { "anyOf": [ { "$ref": "#/components/schemas/MarketCap" }, { "type": "null" } ], "description": "The market cap of securities to retrieve. Returns all market caps if not specified.", "examples": [ "large_cap" ] }, "sort_dir": { "type": "string", "title": "Sort Dir", "description": "The order to sort the results by. One of 'asc' or 'desc'.", "default": "desc", "examples": [ "desc" ] } }, "additionalProperties": false, "type": "object", "title": "PublicGetFundTrendsQuery", "description": "Schema for the request to the fund trends public API." }, "PublicGetHoldingsOverviewQuery": { "properties": { "identifier": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "$ref": "#/components/schemas/IdentifierType", "description": "Object specifying which identifier you are using to request the fund holdings. You must supply one type and its corresponding value.", "examples": [ "rp_entity_id" ] }, "value": { "type": "string", "title": "Value", "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as asset managers and funds. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: BlackRock Inc. (`HJ95FV`)", "examples": [ "HJ95FV" ] } }, "description": "Object specifying which identifier you are using to request the fund holdings. You must supply one type and its corresponding value.", "examples": [ { "type": "rp_entity_id", "value": "HJ95FV" } ] }, "filters": { "anyOf": [ { "$ref": "#/components/schemas/HoldingsOverviewFilters" }, { "type": "null" } ], "description": "Filters specifying fiscal year and quarter", "examples": [ { "quarter": 1, "year": 2025 } ] } }, "type": "object", "required": [ "identifier" ], "title": "PublicGetHoldingsOverviewQuery" }, "PublicGetHoldingsOverviewResponse": { "properties": { "results": { "anyOf": [ { "$ref": "#/components/schemas/PublicGetHoldingsOverviewResult" }, { "$ref": "#/components/schemas/EmptyResponse" } ], "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "$ref": "#/components/schemas/PublicHoldingsRequestMetadata" } }, "type": "object", "required": [ "results", "metadata" ], "title": "PublicGetHoldingsOverviewResponse", "examples": [ { "metadata": { "fiscal_quarter": 1, "fiscal_year": 2025, "fund_name": "blackrock", "request_id": "123e4567-e89b-12d3-a456-426614174000", "rp_entity_id": "HJ95FV", "timestamp": "2025-09-08T10:52:33.453834+00:00" }, "result": { "aum": 258701144516, "aum_change": -8474329733, "aum_change_percent": -3.17, "aum_last": 267175474249, "aum_top_10": 230290501421, "aum_top_10_as_percent_of_aum": 89.02, "capital_flow": -2425356131, "capital_flow_as_percent_of_aum": -0.94, "closed_positions": 2, "closed_positions_change": -1, "closed_positions_last": 3, "etfs_percent": 0.0, "holdings": [ { "active": true, "capital_flow": -438699, "market_value": 5611125.0, "name": "Apple", "portfolio_weight": 4.8588, "rank": 1, "rp_entity_id": "D8442A", "shares": 25261, "shares_change": -1975, "shares_change_percent": -7.25, "shares_last": 27236, "status": "reduced", "ticker": "AAPL" } ], "holdings_change": -3, "holdings_count": 38, "holdings_last": 41, "increased_positions": 7, "increased_positions_change": 2, "increased_positions_last": 5, "new_positions": 0, "new_positions_change": -1, "new_positions_last": 1, "quarter_return": -1.28, "reduced_positions": 6, "reduced_positions_change": -2, "reduced_positions_last": 8, "sector_composition": [ { "percent": 22.92, "sector": { "id": "technology", "name": "Technology" } }, { "percent": 13.96, "sector": { "id": "healthcare", "name": "Healthcare" } }, { "percent": 12.19, "sector": { "id": "financials", "name": "Financials" } } ], "top_transactions": { "buys": [ { "active": true, "capital_flow": 4837420529, "market_value": 10840506706, "name": "Capital One", "portfolio_weight": 0.2064, "rank": 1, "rp_entity_id": "055018", "shares": 50951808, "shares_change": 22736513, "shares_change_percent": 80.58, "shares_last": 28215295, "status": "increased", "ticker": "COF" } ], "sells": [ { "active": false, "capital_flow": -3514847631, "market_value": 0, "name": "Discover Financial Services", "portfolio_weight": 0.0, "rank": 1, "rp_entity_id": "A8CBDA", "shares": 0, "shares_change": -20590789, "shares_change_percent": -100.0, "shares_last": 20590789, "status": "closed", "ticker": "DFS" } ] }, "turnover_percent": 5.26 } } ] }, "PublicGetHoldingsOverviewResult": { "properties": { "holdings": { "items": { "$ref": "#/components/schemas/PublicHolding" }, "type": "array", "title": "Holdings", "description": "List of holdings in the portfolio." }, "quarter_return": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Quarter Return", "description": "The quarter return percentage." }, "aum": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Aum", "description": "Assets under management." }, "aum_last": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Aum Last", "description": "Assets under management in the last period." }, "aum_change": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Aum Change", "description": "Change in assets under management." }, "aum_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Aum Change Percent", "description": "Percentage change in assets under management." }, "aum_top_10": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Aum Top 10", "description": "Assets under management in top 10 holdings." }, "aum_top_10_as_percent_of_aum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Aum Top 10 As Percent Of Aum", "description": "Top 10 holdings as percentage of total AUM." }, "capital_flow": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Capital Flow", "description": "Capital flow amount." }, "capital_flow_as_percent_of_aum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capital Flow As Percent Of Aum", "description": "Capital flow as percentage of AUM." }, "etfs_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Etfs Percent", "description": "Percentage of portfolio in ETFs." }, "turnover_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Turnover Percent", "description": "Portfolio turnover percentage." }, "holdings_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Holdings Count", "description": "Number of holdings." }, "holdings_last": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Holdings Last", "description": "Number of holdings in the last period." }, "holdings_change": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Holdings Change", "description": "Change in number of holdings." }, "new_positions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Positions", "description": "Number of new positions." }, "new_positions_last": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Positions Last", "description": "Number of new positions in the last period." }, "new_positions_change": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Positions Change", "description": "Change in number of new positions." }, "closed_positions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Closed Positions", "description": "Number of closed positions." }, "closed_positions_last": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Closed Positions Last", "description": "Number of closed positions in the last period." }, "closed_positions_change": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Closed Positions Change", "description": "Change in number of closed positions." }, "increased_positions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Increased Positions", "description": "Number of increased positions." }, "increased_positions_last": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Increased Positions Last", "description": "Number of increased positions in the last period." }, "increased_positions_change": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Increased Positions Change", "description": "Change in number of increased positions." }, "reduced_positions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reduced Positions", "description": "Number of reduced positions." }, "reduced_positions_last": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reduced Positions Last", "description": "Number of reduced positions in the last period." }, "reduced_positions_change": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reduced Positions Change", "description": "Change in number of reduced positions." }, "sector_composition": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PublicSectorComposition" }, "type": "array" }, { "type": "null" } ], "title": "Sector Composition", "description": "Sector composition breakdown of the portfolio." }, "top_transactions": { "anyOf": [ { "$ref": "#/components/schemas/PublicTopTransactions" }, { "type": "null" } ], "description": "Top buys and sells transactions for the portfolio." } }, "type": "object", "required": [ "holdings" ], "title": "PublicGetHoldingsOverviewResult", "description": "Result object containing holdings list and portfolio summary data." }, "PublicHolding": { "properties": { "rank": { "type": "integer", "title": "Rank", "description": "The rank of the holding in the portfolio." }, "rp_entity_id": { "anyOf": [ { "type": "string", "maxLength": 6, "minLength": 6 }, { "type": "null" } ], "title": "Rp Entity Id", "description": "RavenPack's internal entity identifier for the stock.", "examples": [ "4A6F00", "D8442A" ] }, "ticker": { "type": "string", "title": "Ticker", "description": "The ticker symbol of the stock." }, "name": { "type": "string", "title": "Name", "description": "The name of the stock." }, "active": { "type": "boolean", "title": "Active", "description": "Whether the stock is active." }, "market_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Market Value", "description": "The market value of the holding." }, "status": { "$ref": "#/components/schemas/HoldingStatus", "description": "The status of the holding." }, "portfolio_weight": { "type": "number", "title": "Portfolio Weight", "description": "The portfolio weight of the holding.", "default": 0 }, "shares": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Shares", "description": "The number of shares held." }, "shares_last": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Shares Last", "description": "The number of shares held in the last period." }, "shares_change": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Shares Change", "description": "The change in the number of shares held." }, "shares_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shares Change Percent", "description": "The percentage change in the number of shares held." }, "capital_flow": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Capital Flow", "description": "The capital flow of the holding." } }, "type": "object", "required": [ "rank", "rp_entity_id", "ticker", "name", "active", "status" ], "title": "PublicHolding", "description": "Model for a single holding in the portfolio." }, "PublicGetPerformanceScoreQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the company profile. You must supply one type and its corresponding value." } }, "type": "object", "required": [ "identifier" ], "title": "PublicGetPerformanceScoreQuery", "description": "Schema for the request to the public API.\n\nOnly contains the identifier:\n- type: the identifier type (e.g., \"rp_entity_id\")\n- value: a single RP Entity ID or a list of IDs" }, "PublicHoldingsRequestMetadata": { "properties": { "request_id": { "type": "string", "title": "Request Id" }, "timestamp": { "type": "string", "title": "Timestamp" }, "rp_entity_id": { "anyOf": [ { "type": "string", "maxLength": 6, "minLength": 6, "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)", "examples": [ "4A6F00" ] }, { "type": "null" } ], "title": "Rp Entity Id", "examples": [ "4A6F00" ] }, "fund_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fund Name", "examples": [ "stillwater-wealth-management-group" ] }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "examples": [ 2025 ] }, "fiscal_quarter": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Quarter", "examples": [ 1 ] } }, "type": "object", "required": [ "request_id" ], "title": "PublicHoldingsRequestMetadata", "description": "Metadata for the request. Includes the backend request." }, "PublicHoldingsRequestMetadataPagination": { "properties": { "request_id": { "type": "string", "title": "Request Id" }, "timestamp": { "type": "string", "title": "Timestamp" }, "rp_entity_id": { "anyOf": [ { "type": "string", "maxLength": 6, "minLength": 6, "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)", "examples": [ "4A6F00" ] }, { "type": "null" } ], "title": "Rp Entity Id", "examples": [ "4A6F00" ] }, "fund_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fund Name", "examples": [ "stillwater-wealth-management-group" ] }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "examples": [ 2025 ] }, "fiscal_quarter": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Quarter", "examples": [ 1 ] }, "pagination": { "anyOf": [ { "$ref": "#/components/schemas/Pagination-Output" }, { "type": "null" } ], "description": "Pagination information for the request.", "examples": [ { "has_next": true, "next": "00000DexaRK4NT6t" } ] } }, "type": "object", "required": [ "request_id" ], "title": "PublicHoldingsRequestMetadataPagination", "description": "Metadata for the request. Includes the backend request." }, "PublicIncomeStatementQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the income statement. You must supply one type and its corresponding value." }, "period": { "$ref": "#/components/schemas/AllowedPeriods", "description": "Select whether the income statement to be provided are on an annual or quarterly basis.", "default": "quarter", "examples": [ "quarter" ] }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "description": "Maximum number of income statements records to return. If omitted, all income statements records are returned.", "default": 20, "examples": [ 20 ] } }, "type": "object", "required": [ "identifier" ], "title": "PublicIncomeStatementQuery" }, "PublicIncomeStatementResponse": { "properties": { "results": { "anyOf": [ { "$ref": "#/components/schemas/IncomeStatement" }, { "additionalProperties": true, "type": "object" } ], "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicIncomeStatementResponse" }, "Status": { "type": "string", "enum": [ "new", "increased", "maintained", "reduced", "closed" ], "title": "Status", "description": "Enum for holding status values." }, "TargetPrice": { "properties": { "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "RavenPack internal entity identifier.", "examples": [ "4A6F00" ] }, "target_identifier_id": { "type": "string", "title": "Target Identifier Id", "description": "The target identifier provided in the request, e.g., stock symbol.", "examples": [ "GOOGL" ] }, "target_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target High", "description": "The target high price of the company.", "examples": [ 290 ] }, "target_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target Low", "description": "The target low price of the company.", "examples": [ 160 ] }, "target_consensus": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target Consensus", "description": "The target consensus price of the company.", "examples": [ 242.31 ] }, "target_median": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target Median", "description": "The target median price of the company.", "examples": [ 265 ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "The currency of the price target values.", "examples": [ "USD" ] } }, "type": "object", "required": [ "rp_entity_id", "target_identifier_id" ], "title": "TargetPrice" }, "TargetPriceQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "An object containing the identifier value(s) and their type for the Target Price tool." } }, "type": "object", "required": [ "identifier" ], "title": "TargetPriceQuery" }, "TimeSeriesSentimentQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/Identifier", "description": "Object specifying which identifier you are using to request the sentiment data. You must supply one type and its corresponding value or a list of entities." }, "timestamp": { "$ref": "#/components/schemas/QueryDateRange", "description": "The time range for retrieving sentiment data. The expected date format is 'YYYY-MM-DD', for example, '2025-09-02'." } }, "type": "object", "required": [ "identifier", "timestamp" ], "title": "TimeSeriesSentimentQuery", "description": "Query model for time series sentiment request.", "example": { "identifier": { "type": "rp_entity_id", "value": "4A6F00" }, "timestamp": { "start": "2025-01-01", "end": "2025-01-20" } } }, "TimeSeriesSentimentResponse": { "properties": { "results": { "$ref": "#/components/schemas/TimeSeriesSentimentResults", "description": "Sentiment time series results" }, "errors": { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array", "title": "Errors", "description": "List of errors encountered while fetching data." }, "metadata": { "$ref": "#/components/schemas/Metadata", "description": "Request metadata including request ID and timestamp." } }, "type": "object", "required": [ "results", "metadata" ], "title": "TimeSeriesSentimentResponse", "description": "Public API response for time series sentiment query." }, "TimeSeriesSentimentResults": { "properties": { "name": { "type": "string", "title": "Name", "description": "Company name", "examples": [ "Alphabet Inc." ] }, "id": { "type": "string", "title": "Id", "description": "RP entity identifier", "examples": [ "4A6F00" ] }, "values": { "items": { "$ref": "#/components/schemas/SentimentDataPoint" }, "type": "array", "title": "Values", "description": "List of sentiment data points", "examples": [ [ { "date": "2025-10-20", "daily_sentiment": 0.017404, "sentiment_pressure": 0.217784, "abnormal_media_attention": -0.833533 }, { "date": "2025-10-21", "daily_sentiment": 0.033251, "sentiment_pressure": 0.208085, "abnormal_media_attention": -0.835593 } ] ] } }, "type": "object", "required": [ "name", "id", "values" ], "title": "TimeSeriesSentimentResults", "description": "Results container for time series sentiment data." }, "TooManyRequestsError": { "properties": { "statusCode": { "type": "integer", "const": 429, "title": "Statuscode", "default": 429 }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "message" ], "title": "TooManyRequestsError", "description": "Too many requests. Please try again later.", "example": { "message": "Too many requests. Please try again later.", "statusCode": 429 } }, "PublicTargetPriceResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/TargetPrice" }, "type": "array", "title": "Results" }, "errors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorDetail" }, "type": "array" }, { "type": "null" } ], "title": "Errors" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/Metadata" }, { "type": "null" } ] } }, "type": "object", "required": [ "results" ], "title": "PublicTargetPriceResponse" }, "PublicTopTransactions": { "properties": { "buys": { "items": { "$ref": "#/components/schemas/PublicHolding" }, "type": "array", "title": "Buys", "description": "List of top buys." }, "sells": { "items": { "$ref": "#/components/schemas/PublicHolding" }, "type": "array", "title": "Sells", "description": "List of top sells." } }, "type": "object", "required": [ "buys", "sells" ], "title": "PublicTopTransactions", "description": "Model for top buys and sells transactions." }, "Quarters": { "type": "integer", "enum": [ 1, 2, 3, 4 ], "title": "Quarters", "description": "Enum for quarters values." }, "QueryDateRange": { "properties": { "start": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start", "description": "The start date of the time range for retrieving daily prices. Only prices occurring on or after this date will be included. The expected date format is 'YYYY-MM-DD', for example, '2025-09-02'", "examples": [ "2025-01-01" ] }, "end": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End", "description": "The end date of the time range for retrieving daily prices. Only prices occurring on or before this date will be included. The expected date format is 'YYYY-MM-DD', for example, '2025-09-03'.", "examples": [ "2025-01-20" ] } }, "type": "object", "title": "QueryDateRange" }, "QueryTimestamp": { "properties": { "start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start", "description": "The start datetime of the time range for retrieving events. Only events occurring on or after this datetime will be included. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-02'" }, "end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End", "description": "The end datetime of the time range for retrieving events. Only events occurring on or before this datetime will be included. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-03'." } }, "type": "object", "title": "QueryTimestamp" }, "QuotaUsage": { "properties": { "api_query_units": { "type": "number", "title": "Api Query Units", "description": "The number of API query units used." } }, "type": "object", "required": [ "api_query_units" ], "title": "QuotaUsage" }, "RankingParams": { "properties": { "source_boost": { "anyOf": [ { "type": "number", "maximum": 10.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Source Boost" }, "freshness_boost": { "anyOf": [ { "type": "number", "maximum": 10.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Freshness Boost" }, "reranker": { "anyOf": [ { "$ref": "#/components/schemas/ReRanker" }, { "type": "null" } ] } }, "type": "object", "title": "RankingParams", "description": "Parameters for ranking the search results." }, "ReRanker": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "title": "ReRanker", "description": "Parameters for reranking the search results." }, "RequestSearchFilters": { "properties": { "timestamp": { "anyOf": [ { "$ref": "#/components/schemas/DateRangeFilter" }, { "type": "null" } ] }, "document_type": { "anyOf": [ { "$ref": "#/components/schemas/DocumentTypeFilter" }, { "type": "null" } ] }, "source": { "anyOf": [ { "$ref": "#/components/schemas/SourceFilter" }, { "type": "null" } ] }, "keyword": { "anyOf": [ { "$ref": "#/components/schemas/KeywordFilter" }, { "type": "null" } ] }, "entity": { "anyOf": [ { "$ref": "#/components/schemas/EntityFilter" }, { "type": "null" } ] } }, "type": "object", "title": "RequestSearchFilters", "description": "A container for all possible filters to narrow down the search scope." }, "SearchQuery": { "properties": { "text": { "type": "string", "minLength": 4, "title": "Text", "description": "The search text for similarity search." }, "filters": { "anyOf": [ { "$ref": "#/components/schemas/RequestSearchFilters" }, { "type": "null" } ] }, "max_chunks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Chunks", "description": "The maximum number of chunks to return." }, "ranking_params": { "anyOf": [ { "$ref": "#/components/schemas/RankingParams" }, { "type": "null" } ] } }, "type": "object", "required": [ "text" ], "title": "SearchQuery", "description": "A search query with optional filters." }, "SearchResults": { "properties": { "results": { "items": { "$ref": "#/components/schemas/Document" }, "type": "array", "title": "Results", "description": "A list of documents that match the search query." }, "usage": { "$ref": "#/components/schemas/QuotaUsage", "description": "The usage of the search query." } }, "type": "object", "required": [ "usage" ], "title": "SearchResults", "description": "The results of a search query." }, "ScreenedCompany": { "properties": { "rp_entity_id": { "type": "string", "maxLength": 6, "minLength": 6, "title": "Rp Entity Id", "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)", "examples": [ "4A6F00" ] }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "The stock symbol of the company.", "examples": [ "AAPL" ] }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name", "description": "The name of the company.", "examples": [ "Apple Inc." ] }, "market_cap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Market Cap", "description": "The market cap of the company.", "examples": [ 3000000000000 ] }, "sector": { "anyOf": [ { "$ref": "#/components/schemas/Sector" }, { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "The sector of the company.", "examples": [ "Technology" ] }, "industry": { "anyOf": [ { "$ref": "#/components/schemas/Industry" }, { "type": "string" }, { "type": "null" } ], "title": "Industry", "description": "The industry of the company.", "examples": [ "Consumer Electronics" ] }, "beta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Beta", "description": "The beta of the company.", "examples": [ 1.2 ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price", "description": "The current price of the company.", "examples": [ 170.5 ] }, "last_annual_dividend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Annual Dividend", "description": "The last annual dividend of the company.", "examples": [ 0.92 ] }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume of the company.", "examples": [ 75000000 ] }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The exchange of the company.", "examples": [ "NASDAQ" ] }, "exchange_short_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange Short Name", "description": "The short name of the exchange.", "examples": [ "NASDAQ" ] }, "country": { "anyOf": [ { "type": "string", "enum": [ "AW", "AF", "AO", "AI", "AX", "AL", "AD", "AE", "AR", "AM", "AS", "AQ", "TF", "AG", "AU", "AT", "AZ", "BI", "BE", "BJ", "BQ", "BF", "BD", "BG", "BH", "BS", "BA", "BL", "BY", "BZ", "BM", "BO", "BR", "BB", "BN", "BT", "BV", "BW", "CF", "CA", "CC", "CH", "CL", "CN", "CI", "CM", "CD", "CG", "CK", "CO", "KM", "CV", "CR", "CU", "CW", "CX", "KY", "CY", "CZ", "DE", "DJ", "DM", "DK", "DO", "DZ", "EC", "EG", "ER", "EH", "ES", "EE", "ET", "FI", "FJ", "FK", "FR", "FO", "FM", "GA", "GB", "GE", "GG", "GH", "GI", "GN", "GP", "GM", "GW", "GQ", "GR", "GD", "GL", "GT", "GF", "GU", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IM", "IN", "IO", "IE", "IR", "IQ", "IS", "IL", "IT", "JM", "JE", "JO", "JP", "KZ", "KE", "KG", "KH", "KI", "KN", "KR", "KW", "LA", "LB", "LR", "LY", "LC", "LI", "LK", "LS", "LT", "LU", "LV", "MO", "MF", "MA", "MC", "MD", "MG", "MV", "MX", "MH", "MK", "ML", "MT", "MM", "ME", "MN", "MP", "MZ", "MR", "MS", "MQ", "MU", "MW", "MY", "YT", "NA", "NC", "NE", "NF", "NG", "NI", "NU", "NL", "NO", "NP", "NR", "NZ", "OM", "PK", "PA", "PN", "PE", "PH", "PW", "PG", "PL", "PR", "KP", "PT", "PY", "PS", "PF", "QA", "RE", "RO", "RU", "RW", "SA", "SD", "SN", "SG", "GS", "SH", "SJ", "SB", "SL", "SV", "SM", "SO", "PM", "RS", "SS", "ST", "SR", "SK", "SI", "SE", "SZ", "SX", "SC", "SY", "TC", "TD", "TG", "TH", "TJ", "TK", "TM", "TL", "TO", "TT", "TN", "TR", "TV", "TW", "TZ", "UG", "UA", "UM", "UY", "US", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "ZA", "ZM", "ZW" ] }, { "type": "null" } ], "title": "Country", "description": "The country code of the company.", "examples": [ "US" ] }, "is_etf": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Etf", "description": "Whether the company's stock is an ETF.", "examples": [ false ] }, "is_actively_trading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Actively Trading", "description": "Whether the company's stock is actively trading.", "examples": [ true ] } }, "type": "object", "required": [ "rp_entity_id", "symbol", "company_name", "market_cap" ], "title": "ScreenedCompany", "description": "Represents a company returned by the screening service." }, "Sector": { "type": "string", "enum": [ "Basic Materials", "Communication Services", "Consumer Cyclical", "Consumer Defensive", "Energy", "Financial Services", "Healthcare", "Industrials", "Real Estate", "Technology", "Utilities" ], "title": "Sector", "description": "Sector enum for public API." }, "SecurityType": { "type": "string", "enum": [ "stock", "etf" ], "title": "SecurityType", "description": "Enum for security type values." }, "SentimentDataPoint": { "properties": { "date": { "type": "string", "title": "Date", "description": "Date in YYYY-MM-DD format", "examples": [ "2025-10-20" ] }, "daily_sentiment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Daily Sentiment", "description": "The daily mean event sentiment represents the weighted average sentiment of all events detected on the same day for a given entity. Each event's sentiment is weighted by its relevance and novelty using a quadratic function. The sentiment score ranges from -1 (negative sentiment) to 1 (positive sentiment). This sentiment is enhanced by considering the entity sentiment from documents without events. Sentiment from subsidiaries is also added at parent level. Use-case: Captures the overall tone of news and events for a company on a given day, ranging from very negative to very positive.", "examples": [ 0.017404 ] }, "sentiment_pressure": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sentiment Pressure", "description": "The Z-score of the 90-days moving average of the daily sentiment normalized to [-1,1] using a sigmoid function. Absolute values over 0.9 can be considered abnormal, which approximately matches 3 standard deviations. A year is considered for z-standardization. Use-case: Measures how sentiment over the last 90 days compares to recent history, highlighting unusually strong positive or negative sentiment trends.", "examples": [ 0.217784 ] }, "abnormal_media_attention": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Abnormal Media Attention", "description": "The Z-score of the daily volume of media events for a company normalized to [-1,1] using a sigmoid function, indicating abnormal media attention. Absolute values over 0.9 can be considered abnormal, which approximately matches 3 standard deviations. Use-case: Indicates whether a company is receiving more or less media attention than usual, based on recent trends.", "examples": [ -0.833533 ] } }, "type": "object", "required": [ "date" ], "title": "SentimentDataPoint", "description": "Individual sentiment data for a specific date." }, "SentimentOptions": { "properties": { "date_range": { "$ref": "#/components/schemas/DateRange", "description": "Date range for filtering sentiment data. Maximum range is 1 year" } }, "type": "object", "required": [ "date_range" ], "title": "SentimentOptions", "description": "Required parameters for sentiment query." }, "SingleIdentifier": { "properties": { "type": { "$ref": "#/components/schemas/IdentifierType", "description": "Object specifying which identifier you are using to request the intraday price. You must supply one type and its corresponding value. Only one identifier should be provided per request.", "examples": [ "rp_entity_id" ] }, "value": { "type": "string", "title": "Value", "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)", "examples": [ "4A6F00" ] } }, "type": "object", "required": [ "type", "value" ], "title": "SingleIdentifier" }, "SourceFilter": { "properties": { "mode": { "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ], "title": "Mode" }, "values": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Values", "description": "List of source identifiers to include or exclude." } }, "type": "object", "required": [ "mode", "values" ], "title": "SourceFilter", "description": "Filters based on source identifiers." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "HoldingsFilters": { "properties": { "year": { "type": "integer", "title": "Year", "examples": [ 2025 ] }, "quarter": { "$ref": "#/components/schemas/Quarters", "examples": [ 1 ] } }, "type": "object", "title": "HoldingsFilters", "description": "Filters for the request." }, "HoldingsMapping": { "properties": { "fund": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "title": "Fund", "default": {}, "examples": [ { "Q1GA4E": "stillwater-wealth-management-group" } ] }, "stock": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "title": "Stock", "default": {}, "examples": [ { "4A6F00": "GOOGL" } ] } }, "type": "object", "title": "HoldingsMapping", "description": "Mapping of RP entity IDs to Wall St Rank symbols used." }, "HoldingsRequestMetadata": { "properties": { "rp_entity_id": { "type": "string", "maxLength": 6, "minLength": 6, "title": "Rp Entity Id", "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)", "default": "", "examples": [ "4A6F00" ] }, "fund_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fund Name", "default": "", "examples": [ "stillwater-wealth-management-group" ] }, "reporting_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reporting Year", "examples": [ 2025 ] }, "reporting_quarter": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reporting Quarter", "examples": [ 1 ] }, "mapping": { "anyOf": [ { "$ref": "#/components/schemas/HoldingsMapping" }, { "type": "null" } ], "description": "Mapping of RP entity IDs to Wall St Rank symbols used.", "examples": [ { "4A6F00": "GOOGL", "D8442A": "AAPL" } ] }, "pagination": { "anyOf": [ { "$ref": "#/components/schemas/Pagination-Output" }, { "type": "null" } ], "description": "Pagination information for the request.", "examples": [ { "has_next": true, "next": "00000DexaRK4NT6t" } ] } }, "type": "object", "title": "HoldingsRequestMetadata", "description": "Metadata for the request. Includes the backend request." }, "PublicCompanySubsidiariesQuery": { "properties": { "identifier": { "$ref": "#/components/schemas/SingleIdentifier", "description": "Object specifying which identifier you are using to request the company profile. You must supply one type and its corresponding value." } }, "type": "object", "required": [ "identifier" ], "title": "PublicCompanySubsidiariesQuery", "description": "Public API request schema for company subsidiaries." }, "PublicCompanySubsidiariesResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/SubsidiaryRecord" }, "type": "array", "title": "Results" }, "errors": { "items": {}, "type": "array", "title": "Errors" }, "metadata": { "$ref": "#/components/schemas/CompanySubsidiariesMetadata" } }, "type": "object", "required": [ "metadata" ], "title": "PublicCompanySubsidiariesResponse" }, "CompanySubsidiariesMetadata": { "properties": { "request_id": { "type": "string", "title": "Request Id" }, "timestamp": { "type": "string", "title": "Timestamp" }, "rp_entity_id": { "type": "string", "title": "Rp Entity Id", "description": "Queried entity ID" } }, "type": "object", "required": [ "request_id", "rp_entity_id" ], "title": "CompanySubsidiariesMetadata" }, "SubsidiaryRecord": { "properties": { "ultimate_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ultimate Parent Id", "description": "Entity ID of the ultimate parent, the topmost entity in the corporate tree, typically the holding company that directly or indirectly owns more than 50% stake in the subsidiaries below it" }, "ultimate_parent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ultimate Parent Name", "description": "Name of the ultimate parent company at the top of the corporate hierarchy" }, "immediate_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Immediate Parent Id", "description": "Entity ID of the immediate parent, the direct owner of this subsidiary, holding a 50% or greater stake in it" }, "immediate_parent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Immediate Parent Name", "description": "Name of the immediate parent company that directly owns this subsidiary" }, "identifier": { "type": "string", "title": "Identifier", "description": "Entity ID of the subsidiary whose position in the corporate ownership structure is being described" }, "entity_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Name", "description": "Name of the subsidiary entity identified by the identifier field" }, "level": { "type": "integer", "title": "Level", "description": "Depth in the corporate hierarchy relative to the ultimate parent (level 1 = the ultimate parent itself, level 2 = direct subsidiary, level 3 = grandchild subsidiary, and so on). Results only include level 2 and deeper." } }, "type": "object", "required": [ "identifier", "level" ], "title": "SubsidiaryRecord" }, "Pagination": { "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor", "description": "Next page token or URL to retrieve the next page of results.", "examples": [ "00000DexaRK4NT6t" ] }, "has_cursor": { "type": "boolean", "title": "Has Cursor", "description": "Whether there are more pages available after this one.", "default": false, "examples": [ true ] } }, "type": "object", "title": "Pagination", "description": "Common pagination response for endpoints that support pagination." } } }, "tags": [ { "name": "Market Data", "description": "Market data endpoints including intraday prices, daily prices, price changes, and real-time quotes" }, { "name": "Analyst Estimates", "description": "Analyst estimates and ratings including analyst ratings, estimates, target prices, and earnings surprises" }, { "name": "Financials & Ratios", "description": "Financial statements and ratios including balance sheet, income statement, cash flow statement, key metrics TTM, and company ratios TTM" }, { "name": "Company & Events", "description": "Company information and events including company profile and events calendar" }, { "name": "Fund Holdings", "description": "Institutional fund holdings from SEC 13F filings including fund holdings and stock fund holdings" }, { "name": "Knowledge Graph", "description": "Corporate ownership and hierarchy data." } ] }