openapi: 3.2.0 info: title: Bigdata Structured Data Company & Events API description: Bigdata API documentation version: 1.0.0 servers: - url: https://api.bigdata.com/ security: - ApiKeyAuth: [] tags: - name: Company & Events description: Company information and events including company profile and events calendar paths: /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. Filter companies by market capitalization, stock price, beta, trading volume, dividend yield, sector, industry, country, exchange, and trading status. Perfect for investment research, portfolio construction, and market analysis.' 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 calls, conference calls, US IPO listings, and US delistings. Query by a specific list of companies, by date range alone, or both, allowing investors and analysts to track upcoming and 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/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. The 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. | Performance | Score Range | |---|---| | Laggard | < 42 | | Below Average | 42 - 47 | | Average | 48 - 53 | | Above Average | 54 - 59 | | 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' /v1/economic-calendar/query: post: tags: - Company & Events summary: Economic Calendar description: 'Returns the macroeconomic releases scheduled in a window: inflation, growth, employment, central bank decisions and the rest of the economic calendar, for the countries requested. Each release carries the figure published, the market consensus and the prior period, so a caller can see both what was expected and what landed. Figures are returned in full units. There is no pagination, and a response is capped at 1000 releases, so narrow the window or the filters to stay under it.' operationId: query_economic_calendar_v1_economic_calendar_query__post requestBody: content: application/json: schema: $ref: '#/components/schemas/EconomicCalendarQuery' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EconomicCalendarResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequestError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsError' components: schemas: 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 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' sources: items: $ref: '#/components/schemas/Source' type: array title: Sources description: The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed. usage: anyOf: - $ref: '#/components/schemas/Usage' - type: 'null' description: Tokens the request consumed, per content tier. Present only for API keys billed in tokens. type: object required: - results title: PublicCompanyScreenerResponse description: Response model for the Company Screener service. EconomicCalendarResponse: properties: results: items: $ref: '#/components/schemas/EconomicEvent' type: array title: Results description: 'The releases in the requested window, ordered by date then country. There is no pagination: the provider serves no cursor, so there is nothing to resume from. A response is capped at 2000 releases and the earliest are kept, so a window that comes back with exactly 2000 may have more that were not returned. An unfiltered window reaches that inside a couple of months, since every country together runs to tens of releases a day once the low-impact ones are counted. Narrow the date range, the countries or the impact levels to stay under it.' errors: anyOf: - items: $ref: '#/components/schemas/ErrorDetail' type: array - type: 'null' title: Errors metadata: anyOf: - $ref: '#/components/schemas/Metadata' - type: 'null' sources: items: $ref: '#/components/schemas/Source' type: array title: Sources description: The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed. usage: anyOf: - $ref: '#/components/schemas/Usage' - type: 'null' description: Tokens the request consumed, per content tier. Present only for API keys billed in tokens. type: object required: - results title: EconomicCalendarResponse example: results: - actual: 250000 actual_is_preliminary: false category: labor-market communication_types: [] consensus: 200000 country: US event_datetime: '2026-02-10T13:30:00Z' impact: HIGH is_all_day: false is_better_than_expected: true is_tentative: false name: Nonfarm Payrolls period_date: '2026-01-01' period_type: MONTH previous: 180000 previous_is_preliminary: false ratio_deviation: 0.25 surprise: 25.0 surprise_unit: '%' 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. AllowedCategories: type: string enum: - earnings-call - conference-call - ipos-calendar - delisted-company title: AllowedCategories Exchange: type: string enum: - AQSE - ARCX - ASEX - BCXE - BMEX - BVMF - DSMD - MISX - NEOE - OTC - ROCO - XAMS - XASX - XBER - XBKK - XBOG - XBOM - XBRU - XBUD - XBUE - XCAI - XCBO - XCNQ - XCSE - XDFM - XDUB - XDUS - XETR - XFRA - XHAM - XHEL - XHKG - XICE - XIDX - XIST - XJPX - XJSE - XKLS - XKOS - XKRX - XKUW - XLIS - XLOM - XLON - XMEX - XMIL - XMUN - XNAS - XNSE - XNYS - XNZE - XOSL - XPAR - XPRA - XRIS - XSAU - XSES - XSGO - XSHE - XSHG - XSTC - XSTO - XSTU - XSWX - XTAE - XTAI - XTAL - XTSE - XTSX - XWAR - XWBO - AQS - AMEX - ATH - DXE - BME - SAO - DOH - MCX - NEO - TWO - AMS - ASX - BER - SET - BVC - BSE - BRU - BUD - BUE - EGX - CBOE - CNQ - CPH - DFM - DUB - DUS - XETRA - FSX - HAM - HEL - HKSE - ICE - JKT - IST - JPX - JNB - KLS - KOE - KSC - KUW - LIS - IOB - LSE - MEX - MIL - MUN - NASDAQ - NSE - NYSE - NZE - OSL - PAR - PRA - RIS - SAU - SES - SGO - SHZ - SHH - HOSE - STO - STU - SIX - TLV - TAI - TAL - TSX - TSXV - WSE - VIE title: Exchange PeriodType: type: string enum: - NONE - DAY - MONTH - QUARTER title: PeriodType description: 'The granularity of the period a figure describes. ``NONE`` is how a release with no period behind it is reported, such as a central bank speech. It arrives as this name rather than as null, and those releases carry no ``period_date`` either.' ImpactLevel: type: string enum: - NONE - LOW - MEDIUM - HIGH title: ImpactLevel description: 'How much market movement a release is expected to cause. The ''impacts'' filter takes these names, and each release answers the one it carries. Case does not matter.' ErrorDetail: properties: message: anyOf: - type: string - type: 'null' title: Message type: object title: ErrorDetail 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. 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' metadata: anyOf: - $ref: '#/components/schemas/Metadata' - type: 'null' sources: items: $ref: '#/components/schemas/Source' type: array title: Sources description: The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed. usage: anyOf: - $ref: '#/components/schemas/Usage' - type: 'null' description: Tokens the request consumed, per content tier. Present only for API keys billed in tokens. type: object required: - results title: PublicCompanyProfileResponse description: Response model for company profile query. EconomicCategory: type: string enum: - bond-auctions - capital-flows - central-banks - consumption - economic-activity - energy - holidays - housing-market - inflation - interest-rates - labor-market - politics title: EconomicCategory PublicGetPerformanceScoreQuery: properties: identifier: $ref: '#/components/schemas/SingleIdentifier' description: Object specifying which identifier you are using to request the company's environmental, social and governance (ESG) scores. You must supply one type and its corresponding value. type: object required: - identifier title: PublicGetPerformanceScoreQuery description: 'Schema for the request to the public API. Only contains the identifier: - type: the identifier type (e.g., "rp_entity_id") - value: a single RP Entity ID or a list of IDs' EmptyResponse: properties: {} type: object title: EmptyResponse 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''.' sources: items: $ref: '#/components/schemas/Source' type: array title: Sources description: The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed. usage: anyOf: - $ref: '#/components/schemas/Usage' - type: 'null' description: Tokens the request consumed, per content tier. Present only for API keys billed in tokens. type: object required: - results title: 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' CommunicationType: type: string enum: - REPORT - SPEECH title: CommunicationType description: 'A form an entry takes when it is prose rather than a figure. The provider flags the two independently and may set both, so a row carries them as a list rather than choosing between them.' EconomicCalendarQuery: properties: start_date: type: string format: date title: Start Date description: First day of the window, as YYYY-MM-DD. Inclusive. examples: - '2026-01-01' end_date: type: string format: date title: End Date description: Last day of the window, as YYYY-MM-DD. Inclusive. examples: - '2026-01-31' countries: anyOf: - items: $ref: '#/components/schemas/EconomicCalendarCountryCode' type: array - type: 'null' title: Countries description: Countries to return releases for, as ISO 3166-1 alpha-2 codes (case-insensitive). 'UK' is accepted as an alias for 'GB' and returned as 'GB'. The sole non-ISO code is 'EMU' (euro area), which carries ECB decisions and euro-area aggregates. Omit to cover all countries. examples: - - US - GB - EMU impacts: anyOf: - items: $ref: '#/components/schemas/ImpactLevel' type: array - type: 'null' title: Impacts description: Expected market impact levels to return. Omit for every level. Case does not matter. examples: - - HIGH - MEDIUM categories: anyOf: - items: $ref: '#/components/schemas/EconomicCategory' type: array - type: 'null' title: Categories description: 'Categories to filter by. Valid values: bond-auctions, capital-flows, central-banks, consumption, economic-activity, energy, holidays, housing-market, inflation, interest-rates, labor-market, politics. Omit for every category. A value outside that set is rejected.' examples: - - inflation - labor-market additionalProperties: false type: object required: - start_date - end_date title: EconomicCalendarQuery example: categories: - inflation - labor-market countries: - US - GB - EMU end_date: '2026-01-31' impacts: - HIGH - MEDIUM start_date: '2026-01-01' 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 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 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 PublicESGPerformanceScoreResponse: properties: results: anyOf: - $ref: '#/components/schemas/ESGPerformanceScore' - $ref: '#/components/schemas/EmptyResponse' title: Results metadata: anyOf: - $ref: '#/components/schemas/Metadata' - type: 'null' sources: items: $ref: '#/components/schemas/Source' type: array title: Sources description: The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed. usage: anyOf: - $ref: '#/components/schemas/Usage' - type: 'null' description: Tokens the request consumed, per content tier. Present only for API keys billed in tokens. type: object required: - results title: PublicESGPerformanceScoreResponse 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 TooManyRequestsError: properties: statusCode: type: integer const: 429 title: Statuscode default: 429 message: type: string title: Message type: object required: - message title: TooManyRequestsError description: Too many requests. Please try again later. example: message: Too many requests. Please try again later. statusCode: 429 IdentifierType: type: string enum: - rp_entity_id title: IdentifierType default: rp_entity_id 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' 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. Source: properties: id: type: string title: Id description: Content catalog identifier of the source. examples: - CA9FA3 name: type: string title: Name description: Catalog name of the dataset the data came from. examples: - Corporate Fundamentals type: object required: - id - name title: Source description: A content catalog source that contributed data to a structured-data response. SingleIdentifier: properties: type: $ref: '#/components/schemas/IdentifierTypeEnum' description: Object specifying which identifier you are using to request the data. You must supply one type and its corresponding value. Only one identifier should be provided per request. examples: - rp_entity_id value: type: string maxLength: 6 minLength: 6 title: Value description: 'Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)' examples: - 4A6F00 type: object required: - type - value title: SingleIdentifier EconomicCalendarCountryCode: type: string enum: - AE - AR - AT - AU - BE - BR - CA - CH - CL - CN - CO - CZ - DE - DK - EG - EMU - ES - FI - FR - GB - GR - HK - HU - ID - IE - IL - IN - IS - IT - JP - KR - KW - MX - NL - 'NO' - NZ - PL - PT - QA - RO - RU - SA - SE - SG - SK - TH - TR - UA - UK - US - VN - ZA title: EconomicCalendarCountryCode SurpriseUnit: type: string enum: - '%' - pp title: SurpriseUnit description: 'What a surprise figure is measured in. An indicator already published as a percentage is compared by subtraction, so its surprise is a number of percentage points; every other indicator is compared relatively, so its surprise is a percentage of the consensus. Both are percent-shaped numbers and they are not the same measurement, which is why a row carries this alongside the figure.' 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. IdentifierTypeEnum: type: string enum: - rp_entity_id title: IdentifierTypeEnum InternalServerError: properties: statusCode: type: integer const: 500 title: Statuscode default: 500 message: type: string title: Message type: object required: - message title: InternalServerError description: Internal Server Error example: message: Internal Server Error statusCode: 500 Usage: additionalProperties: type: integer type: object title: Usage description: 'Public structured-data usage for a request, aggregated per content tier. A flat object keyed per content tier, where each key is derived from the content tier identifier by dropping the ``content-`` prefix and appending ``_tokens`` (e.g. ``corporate-fundamentals`` -> ``corporate_fundamentals_tokens``). It is sparse: only tiers with non-zero tokens appear, and an absent key means zero tokens for that tier.' 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: - $ref: '#/components/schemas/Exchange' - type: 'null' description: The exchange the company trades on, given either as its market identifier code, such as `XNAS` for Nasdaq or `XNYS` for the New York Stock Exchange, or as the short exchange code shown in screener results, such as `NASDAQ`. Not case-sensitive. examples: - XNAS type: object title: CompanyScreenerFilters description: Filters for the company screener request. 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. EconomicEvent: properties: event_datetime: type: string format: date-time title: Event Datetime description: When the figure is released, in ISO 8601 format (UTC). examples: - '2026-02-10T13:30:00Z' country: type: string title: Country description: 'Country the release covers. Every value is an ISO 3166-1 alpha-2 code except one: ''EMU'', the euro area, which has no ISO code of its own.' examples: - US name: type: string title: Name description: Name of the economic indicator. examples: - Nonfarm Payrolls impact: anyOf: - $ref: '#/components/schemas/ImpactLevel' - type: 'null' description: 'Expected market impact: NONE, LOW, MEDIUM or HIGH.' examples: - HIGH period_date: anyOf: - type: string format: date - type: 'null' title: Period Date description: 'The period the figure describes, as ''YYYY-MM-DD'', which is not when it was released: a December CPI published in January describes December. Read it with ''period_type'', which says whether the period is that day, its month or its quarter. Absent on an event with no period, such as a central bank speech.' examples: - '2026-01-01' period_type: anyOf: - $ref: '#/components/schemas/PeriodType' - type: 'null' description: 'Granularity of the period: DAY, MONTH or QUARTER. ''NONE'' on a release that has no period behind it, such as a central bank speech, where ''period_date'' is absent too.' examples: - MONTH actual: anyOf: - type: number - type: 'null' title: Actual description: The released figure, in full units. Absent until the release happens, which is the usual state for a forward-looking window. examples: - 250000 consensus: anyOf: - type: number - type: 'null' title: Consensus description: Market expectation, in full units. examples: - 200000 previous: anyOf: - type: number - type: 'null' title: Previous description: The prior period's figure, in full units. examples: - 180000 revised: anyOf: - type: number - type: 'null' title: Revised description: The prior period restated, in full units. When present, 'previous' is the figure as first published and this is the corrected one. examples: - 185000 ratio_deviation: anyOf: - type: number - type: 'null' title: Ratio Deviation description: The provider's own measure of how far the released figure fell from consensus, as a ratio. Published by FXStreet alongside the figures; 'surprise' is the same idea expressed as a signed percentage. examples: - 0.25 surprise: anyOf: - type: number - type: 'null' title: Surprise description: 'How far the released figure fell from the consensus, signed. Read it with ''surprise_unit'', which says which of two comparisons produced it: an indicator already published as a percentage is compared by subtraction, in percentage points, and every other indicator relatively, as a percentage of the consensus. Absent when either figure is, and for the relative comparison when the consensus is zero.' examples: - 25.0 surprise_unit: anyOf: - $ref: '#/components/schemas/SurpriseUnit' - type: 'null' description: 'What ''surprise'' is measured in: ''pp'' for percentage points, on an indicator already published as a percentage such as a CPI rate, and ''%'' for a percentage of the consensus on every other indicator, such as a payroll count. Absent exactly when ''surprise'' is. Two surprises cannot be compared without it: -0.2pp and -6.25% describe the same release.' examples: - '%' is_better_than_expected: anyOf: - type: boolean - type: 'null' title: Is Better Than Expected description: 'Whether the result is good for the economy, as judged by the provider. Direction-aware, unlike ''surprise'': a lower unemployment print is a negative surprise and better than expected.' examples: - true unit: anyOf: - type: string - type: 'null' title: Unit description: 'What the figures are measured in: ''%'' for a rate, ''$'' for a monetary value, absent for a count such as jobs.' examples: - '%' category: anyOf: - $ref: '#/components/schemas/EconomicCategory' - type: 'null' description: The category this indicator is filed under, named the same way the 'categories' filter names one. Absent when the provider filed the event under no category. examples: - labor-market communication_types: items: $ref: '#/components/schemas/CommunicationType' type: array title: Communication Types description: 'The prose forms this entry takes: ''REPORT'' for a published document, ''SPEECH'' for spoken remarks, and both when it is both. Empty on an ordinary data release, which is most of a calendar.' examples: - - SPEECH is_all_day: anyOf: - type: boolean - type: 'null' title: Is All Day description: Whether the event covers the whole day rather than a moment in it. When true, the time of day carried by 'event_datetime' is a convention and not a release time. examples: - false is_tentative: anyOf: - type: boolean - type: 'null' title: Is Tentative description: Whether the timing is provisional. When true, 'event_datetime' is the provider's best estimate of when the figure lands rather than a scheduled time, so do not rely on it to the minute. examples: - false actual_is_preliminary: anyOf: - type: boolean - type: 'null' title: Actual Is Preliminary description: Whether 'actual' is a first estimate. A preliminary figure is normally restated in a later release. examples: - false previous_is_preliminary: anyOf: - type: boolean - type: 'null' title: Previous Is Preliminary description: Whether 'previous' is a first estimate rather than a settled figure. This is what a value in 'revised' corrects. examples: - false type: object required: - event_datetime - country - name title: EconomicEvent Metadata: properties: request_id: type: string title: Request Id timestamp: type: string title: Timestamp type: object required: - request_id title: Metadata 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. securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY