generated: '2026-10-20'
method: derived
generator: derive-vocabulary.py
source:
- openapi/bigdata-analyst-estimates-api-openapi.yml
- openapi/bigdata-company-events-api-openapi.yml
- openapi/bigdata-financials-ratios-api-openapi.yml
- openapi/bigdata-fixed-income-api-openapi.yml
- openapi/bigdata-fund-holdings-api-openapi.yml
vocabulary:
  name: RavenPack Domain Vocabulary
  description: 'Terms declared by RavenPack''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-20'
  terms:
  - term: Analyst Estimates
    definition: Analyst estimates and ratings including analyst ratings, estimates, target prices, and earnings surprises
    tags:
    - Resource Group
    source: openapi/bigdata-analyst-estimates-api-openapi.yml
  - term: Company & Events
    definition: Company information and events including company profile and events calendar
    tags:
    - Resource Group
    source: openapi/bigdata-company-events-api-openapi.yml
  - term: Financials & Ratios
    definition: Financial statements and ratios including balance sheet, income statement, cash flow statement, key metrics TTM, and company ratios
      TTM
    tags:
    - Resource Group
    source: openapi/bigdata-financials-ratios-api-openapi.yml
  - term: Fixed Income
    definition: 'Bond reference data: the bonds a company has issued and their terms'
    tags:
    - Resource Group
    source: openapi/bigdata-fixed-income-api-openapi.yml
  - term: Fund Holdings
    definition: Institutional fund holdings from SEC 13F filings including fund holdings and stock fund holdings
    tags:
    - Resource Group
    source: openapi/bigdata-fund-holdings-api-openapi.yml
  - term: Market Data
    definition: Market data endpoints including intraday prices, daily prices, price changes, and real-time quotes
    tags:
    - Resource Group
    source: openapi/bigdata-market-data-api-openapi.yml
  - term: Private Markets
    definition: Private company data including profile, headquarters, funding totals and valuation
    tags:
    - Resource Group
    source: openapi/bigdata-private-markets-api-openapi.yml
  - term: AnalystRatingsResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/AnalystRatingsResponse
  - term: TargetPriceQuery
    definition: 'Object declared by the contract with fields: identifier.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/TargetPriceQuery
  - term: Consensus
    definition: Enum for the consensus rating of analysts.
    tags:
    - Enumeration
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/Consensus
  - term: IdentifierType
    definition: 'Enumeration declared by the contract with values: rp_entity_id.'
    tags:
    - Enumeration
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/IdentifierType
  - term: Usage
    definition: '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 th'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/Usage
  - term: PublicAnalystEstimatesQuery
    definition: 'Object declared by the contract with fields: identifier, period, limit.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/PublicAnalystEstimatesQuery
  - term: AllowedPeriods
    definition: 'Enumeration declared by the contract with values: annual, quarter.'
    tags:
    - Enumeration
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/AllowedPeriods
  - term: ErrorDetail
    definition: 'Object declared by the contract with fields: message.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/ErrorDetail
  - term: PublicAnalystEstimatesResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/PublicAnalystEstimatesResponse
  - term: AnalystRatingsQuery
    definition: 'Object declared by the contract with fields: identifier.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/AnalystRatingsQuery
  - term: Source
    definition: A content catalog source that contributed data to a structured-data response.
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/Source
  - term: AnalystRatings
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, strong_buy, buy, hold, sell, strong_sell, consensus.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/AnalystRatings
  - term: LatestSurprise
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, reporting_date, eps_actual, eps_estimated, revenue_actual,
      revenue_estimated, last_updated, eps_surprise_pct, revenue_surprise_pct.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/LatestSurprise
  - term: TargetPrice
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, target_high, target_low, target_consensus, target_median,
      currency.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/TargetPrice
  - term: Metadata
    definition: 'Object declared by the contract with fields: request_id, timestamp.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/Metadata
  - term: AnalystEstimates
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, fields, values.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/AnalystEstimates
  - term: Identifier
    definition: 'Object declared by the contract with fields: type, value.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/Identifier
  - term: LatestSurpriseResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/LatestSurpriseResponse
  - term: PublicTargetPriceResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/PublicTargetPriceResponse
  - term: LatestSurpriseQuery
    definition: 'Object declared by the contract with fields: identifier.'
    tags:
    - Object
    source: openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/LatestSurpriseQuery
  - term: PeriodType
    definition: 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.
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/PeriodType
  - term: Sector
    definition: Sector enum for public API.
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/Sector
  - term: Industry
    definition: Industry enum for public API.
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/Industry
  - term: EconomicEvent
    definition: 'Object declared by the contract with fields: event_datetime, country, name, impact, period_date, period_type, actual, consensus,
      previous, revised, ratio_deviation, surprise. (9 more)'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/EconomicEvent
  - term: Exchange
    definition: 'Enumeration declared by the contract with values: AQSE, ARCX, ASEX, BCXE, BMEX, BVMF, DSMD, MISX, NEOE, OTC, ROCO, XAMS. (129
      more)'
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/Exchange
  - term: PublicGetPerformanceScoreQuery
    definition: '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'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/PublicGetPerformanceScoreQuery
  - term: EconomicCategory
    definition: 'Enumeration declared by the contract with values: bond-auctions, capital-flows, central-banks, consumption, economic-activity,
      energy, holidays, housing-market, inflation, interest-rates, labor-market, politics.'
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/EconomicCategory
  - term: ScreenedCompany
    definition: Represents a company returned by the screening service.
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/ScreenedCompany
  - term: CommunicationType
    definition: 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.
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/CommunicationType
  - term: InternalServerError
    definition: Internal Server Error
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/InternalServerError
  - term: EconomicCalendarResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/EconomicCalendarResponse
  - term: PublicESGPerformanceScoreResponse
    definition: 'Object declared by the contract with fields: results, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/PublicESGPerformanceScoreResponse
  - term: SingleIdentifier
    definition: 'Object declared by the contract with fields: type, value.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/SingleIdentifier
  - term: Pagination
    definition: Common pagination response for endpoints that support pagination.
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/Pagination
  - term: TooManyRequestsError
    definition: Too many requests. Please try again later.
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/TooManyRequestsError
  - term: ESGPerformanceScore
    definition: 'Object declared by the contract with fields: rp_entity_id, name, ticker, industry, economic_sector, esg_scores, values.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/ESGPerformanceScore
  - term: CompanyScreenerFilters
    definition: Filters for the company screener request.
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/CompanyScreenerFilters
  - term: EconomicCalendarQuery
    definition: 'Object declared by the contract with fields: start_date, end_date, countries, impacts, categories.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/EconomicCalendarQuery
  - term: SurpriseUnit
    definition: 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.
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/SurpriseUnit
  - term: PublicCompanyProfileResponse
    definition: Response model for company profile query.
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/PublicCompanyProfileResponse
  - term: IdentifierQuery
    definition: 'Object declared by the contract with fields: identifier.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/IdentifierQuery
  - term: CompanyScreenerQuery
    definition: Allows filtering companies based on various financial and descriptive criteria.
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/CompanyScreenerQuery
  - term: IdentifierTypeEnum
    definition: 'Enumeration declared by the contract with values: rp_entity_id.'
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/IdentifierTypeEnum
  - term: AllowedCategories
    definition: 'Enumeration declared by the contract with values: earnings-call, conference-call, ipos-calendar, delisted-company.'
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/AllowedCategories
  - term: EventsCalendarResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, pagination, events_unmapped, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/EventsCalendarResponse
  - term: CompanyProfileData
    definition: Company profile data model.
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/CompanyProfileData
  - term: EconomicCalendarCountryCode
    definition: 'Enumeration declared by the contract with values: AE, AR, AT, AU, BE, BR, CA, CH, CL, CN, CO, CZ. (40 more)'
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/EconomicCalendarCountryCode
  - term: EventCalendar
    definition: 'Object declared by the contract with fields: category, event_datetime, title, fiscal_year, fiscal_period, rp_collection_id, updated_at,
      created_at, ticker, company_name, exchange.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/EventCalendar
  - term: ImpactLevel
    definition: 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.
    tags:
    - Enumeration
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/ImpactLevel
  - term: BadRequestError
    definition: Bad Request Error
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/BadRequestError
  - term: PublicCompanyScreenerResponse
    definition: Response model for the Company Screener service.
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/PublicCompanyScreenerResponse
  - term: EventsCalendarQuery
    definition: 'Object declared by the contract with fields: rp_entity_id, start_date, end_date, countries, exchanges, categories, cursor, limit.'
    tags:
    - Object
    source: openapi/bigdata-company-events-api-openapi.yml#/components/schemas/EventsCalendarQuery
  - term: CompanyRatiosTTMResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/CompanyRatiosTTMResponse
  - term: IncomeStatement
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, fields, values.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/IncomeStatement
  - term: PublicCompanyRevenueProductResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicCompanyRevenueProductResponse
  - term: KeyMetricsTTMQuery
    definition: 'Object declared by the contract with fields: identifier.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/KeyMetricsTTMQuery
  - term: CashFlowStatement
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, fields, values.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/CashFlowStatement
  - term: KeyMetricsTTMResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/KeyMetricsTTMResponse
  - term: BalanceSheet
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, fields, values.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/BalanceSheet
  - term: PublicBalanceSheetQuery
    definition: 'Object declared by the contract with fields: identifier, period, limit.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicBalanceSheetQuery
  - term: PublicCompanyRevenueProductQuery
    definition: 'Object declared by the contract with fields: identifier, period.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicCompanyRevenueProductQuery
  - term: PublicCashFlowResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicCashFlowResponse
  - term: CompanyRevenueProduct
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, fields, values.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/CompanyRevenueProduct
  - term: PublicCashFlowStatementQuery
    definition: 'Object declared by the contract with fields: identifier, period, limit.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicCashFlowStatementQuery
  - term: PublicIncomeStatementQuery
    definition: 'Object declared by the contract with fields: identifier, period, limit.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicIncomeStatementQuery
  - term: PublicCompanyRevenueGeographicResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicCompanyRevenueGeographicResponse
  - term: CompanyRevenueGeographic
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, fields, values.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/CompanyRevenueGeographic
  - term: KeyMetricsTTM
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, market_cap, enterprise_value_ttm, ev_to_sales_ttm,
      ev_to_operating_cash_flow_ttm, ev_to_free_cash_flow_ttm, ev_to_ebitda_ttm, net_debt_to_ebitda_ttm, current_ratio_ttm, income_quality_ttm,
      graham_number_ttm. (32 more)'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/KeyMetricsTTM
  - term: PublicCompanyRevenueGeographicQuery
    definition: 'Object declared by the contract with fields: identifier, period.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicCompanyRevenueGeographicQuery
  - term: PublicIncomeStatementResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicIncomeStatementResponse
  - term: CompanyRatiosTTMQuery
    definition: 'Object declared by the contract with fields: identifier.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/CompanyRatiosTTMQuery
  - term: CompanyRatiosTTM
    definition: 'Object declared by the contract with fields: rp_entity_id, target_identifier_id, gross_profit_margin_ttm, ebit_margin_ttm, ebitda_margin_ttm,
      operating_profit_margin_ttm, pretax_profit_margin_ttm, continuous_operations_profit_margin_ttm, net_profit_margin_ttm, bottom_line_profit_margin_ttm,
      receivables_turnover_ttm, payables_turnover_ttm. (49 more)'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/CompanyRatiosTTM
  - term: PublicBalanceSheetResponse
    definition: 'Object declared by the contract with fields: results, errors, metadata, sources, usage.'
    tags:
    - Object
    source: openapi/bigdata-financials-ratios-api-openapi.yml#/components/schemas/PublicBalanceSheetResponse