Fincept Terminal Macroeconomic API

openapi: 3.2.0
info:
  title: Fincept In Macroeconomic API
  version: 3.0.0
  description: 'Operations tagged macroeconomic across 2 of this provider''s published API definitions: fincept-in-openapi.json, fincept-in-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: macroeconomic
paths:
  /macro/ceic/indicators:
    get:
      tags:
      - macroeconomic
      summary: Get Ceic Indicators
      description: 'Browse CEIC indicator catalog (metadata)


        **Credits:** configurable (see MACRO_* env vars)


        **Returns:** Indicator name, unit, category, frequency, date range per country'
      operationId: get_ceic_indicators_macro_ceic_indicators_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country (e.g. china, united-states)
          title: Country
        description: Filter by country (e.g. china, united-states)
      - name: category
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by category (partial match)
          title: Category
        description: Filter by category (partial match)
      - name: slug
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by indicator slug (partial match)
          title: Slug
        description: Filter by indicator slug (partial match)
      - name: frequency
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by frequency (e.g. quarterly, monthly, annual)
          title: Frequency
        description: Filter by frequency (e.g. quarterly, monthly, annual)
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          default: 100
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/ceic/countries:
    get:
      tags:
      - macroeconomic
      summary: Get Ceic Countries
      description: 'Get list of unique countries in CEIC indicator catalog


        **Credits:** configurable (see MACRO_* env vars); cache hits are free'
      operationId: get_ceic_countries_macro_ceic_countries_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - APIKeyHeader: []
  /macro/ceic/categories:
    get:
      tags:
      - macroeconomic
      summary: Get Ceic Categories
      description: 'Get list of unique categories in CEIC indicator catalog


        **Credits:** configurable (see MACRO_* env vars); cache hits are free'
      operationId: get_ceic_categories_macro_ceic_categories_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country
          title: Country
        description: Filter by country
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/ceic/health:
    get:
      tags:
      - macroeconomic
      summary: Ceic Health Check
      description: 'Check CEIC database connectivity


        **Credits:** Free'
      operationId: ceic_health_check_macro_ceic_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - APIKeyHeader: []
  /macro/economic-calendar:
    get:
      tags:
      - macroeconomic
      summary: Get Economic Calendar Events
      description: 'Get economic calendar events with flexible filtering


        **Credits:** configurable (see MACRO_* env vars); cache hits are free


        **Data Source:** ForexFactory and other financial calendars

        **Date Range:** 2007-01-01 to 2026-02-27

        **Total Events:** 200,000+


        **Filters:**

        - currency: Filter by currency code (USD, EUR, GBP, JPY, AUD, CAD, NZD, CNY, CHF, etc.)

        - impact: Filter by impact level (Low, Medium, High, Holiday)

        - event_name: Search in event names (case-insensitive partial match)

        - start_date: Filter events from this date/time onwards

        - end_date: Filter events up to this date/time

        - source: Filter by data source (forexfactory, etc.)

        - limit: Maximum records (1-1000, default 100)

        - offset: Skip records for pagination


        **Returns:**

        - List of economic calendar events with full details

        - Total count of matching records

        - Applied filters summary


        **Event Fields:**

        - event_datetime: When the event occurs

        - currency: Currency affected by the event

        - impact: Impact level on the market

        - event_name: Name of the economic indicator/event

        - actual: Actual value released

        - forecast: Forecasted value

        - previous: Previous value

        - detail_url: Link to more details'
      operationId: get_economic_calendar_events_macro_economic_calendar_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: currency
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by currency code (e.g., USD, EUR, GBP)
          title: Currency
        description: Filter by currency code (e.g., USD, EUR, GBP)
      - name: impact
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by impact level (Low, Medium, High, Holiday)
          title: Impact
        description: Filter by impact level (Low, Medium, High, Holiday)
      - name: event_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Search event name (partial match)
          title: Event Name
        description: Search event name (partial match)
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Start datetime (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
          title: Start Date
        description: Start datetime (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: End datetime (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
          title: End Date
        description: End datetime (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
      - name: source
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by data source (e.g., forexfactory)
          title: Source
        description: Filter by data source (e.g., forexfactory)
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: Maximum number of records to return
          default: 100
          title: Limit
        description: Maximum number of records to return
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Number of records to skip
          default: 0
          title: Offset
        description: Number of records to skip
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/ceic/series:
    get:
      tags:
      - macroeconomic
      summary: Get Ceic Series
      description: 'Query CEIC time-series data by country and indicator


        **Credits:** configurable (see MACRO_* env vars); cache hits are free


        **Available Countries:** china, united-states, germany, japan, france, european-union


        **Filters:**

        - country: Country name slug

        - indicator: Indicator slug extracted from series_id

        - year_from / year_to: Year range filter

        - latest_only: Collapse each series to its most recent point

        - limit / offset: Pagination


        **Returns:** Time-series values with period, year, and value


        **latest_only:** a dashboard showing the current value of every indicator

        for a country would otherwise have to page the entire history — 45k+ rows

        for united-states, billed per page. This collapses to one row per series_id

        in a single request.'
      operationId: get_ceic_series_macro_ceic_series_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country (e.g. china, united-states, germany, japan, france, european-union)
          title: Country
        description: Filter by country (e.g. china, united-states, germany, japan, france, european-union)
      - name: indicator
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by indicator slug (e.g. nominal-gdp, consumer-price-index-cpi-growth)
          title: Indicator
        description: Filter by indicator slug (e.g. nominal-gdp, consumer-price-index-cpi-growth)
      - name: year_from
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter from year (e.g. 2000)
          title: Year From
        description: Filter from year (e.g. 2000)
      - name: year_to
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter to year (e.g. 2024)
          title: Year To
        description: Filter to year (e.g. 2024)
      - name: latest_only
        in: query
        required: false
        schema:
          type: boolean
          description: Return only the most recent point per series_id
          default: false
          title: Latest Only
        description: Return only the most recent point per series_id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: Max records to return
          default: 100
          title: Limit
        description: Max records to return
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Records to skip
          default: 0
          title: Offset
        description: Records to skip
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/ceic/series/countries:
    get:
      tags:
      - macroeconomic
      summary: Get Ceic Series Countries
      description: 'Get list of available countries in CEIC series


        **Credits:** configurable (see MACRO_* env vars); cache hits are free'
      operationId: get_ceic_series_countries_macro_ceic_series_countries_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - APIKeyHeader: []
  /macro/ceic/series/indicators:
    get:
      tags:
      - macroeconomic
      summary: Get Ceic Series Indicators
      description: 'Get list of available indicators in CEIC series


        **Credits:** configurable (see MACRO_* env vars); cache hits are free'
      operationId: get_ceic_series_indicators_macro_ceic_series_indicators_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter indicators by country
          title: Country
        description: Filter indicators by country
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/upcoming-events:
    get:
      tags:
      - macroeconomic
      summary: Get Te Economic Calendar
      description: 'Query Trading Economics economic calendar events


        **Credits:** configurable (see MACRO_* env vars); cache hits are free


        **Data:** Near-term economic events scraped from Trading Economics

        **Date Range:** Current week and upcoming days


        **Filters:**

        - country: ISO country code (US, DE, JP, GB, FR, CA, AU, IN, etc.)

        - category: Event category (partial match)

        - event: Event name search (partial match)

        - start_date / end_date: Date range (YYYY-MM-DD)

        - importance: Importance level (integer)

        - limit / offset: Pagination


        **Returns:** Economic events with actual, forecast, previous values'
      operationId: get_te_economic_calendar_macro_upcoming_events_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country code (e.g. US, DE, JP, GB, FR, IN)
          title: Country
        description: Filter by country code (e.g. US, DE, JP, GB, FR, IN)
      - name: category
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by category (partial match)
          title: Category
        description: Filter by category (partial match)
      - name: event
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Search by event name (partial match)
          title: Event
        description: Search by event name (partial match)
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Start date (YYYY-MM-DD)
          title: Start Date
        description: Start date (YYYY-MM-DD)
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: End date (YYYY-MM-DD)
          title: End Date
        description: End date (YYYY-MM-DD)
      - name: importance
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by importance level
          title: Importance
        description: Filter by importance level
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: Max records to return
          default: 100
          title: Limit
        description: Max records to return
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Records to skip
          default: 0
          title: Offset
        description: Records to skip
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/wgb/central-bank-rates:
    get:
      tags:
      - macroeconomic
      summary: Get Central Bank Rates
      description: 'Get central bank interest rates by country


        **Credits:** configurable (see MACRO_* env vars)


        **Returns:** Country, rate (%), change in basis points, period'
      operationId: get_central_bank_rates_macro_wgb_central_bank_rates_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country name (partial match)
          title: Country
        description: Filter by country name (partial match)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/wgb/credit-ratings:
    get:
      tags:
      - macroeconomic
      summary: Get Credit Ratings
      description: 'Get sovereign credit ratings from S&P, Moody''s, Fitch, DBRS


        **Credits:** configurable (see MACRO_* env vars)


        **Returns:** Country, S&P rating, Moody''s rating, Fitch rating, DBRS rating'
      operationId: get_credit_ratings_macro_wgb_credit_ratings_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country name (partial match)
          title: Country
        description: Filter by country name (partial match)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/wgb/sovereign-cds:
    get:
      tags:
      - macroeconomic
      summary: Get Sovereign Cds
      description: 'Get sovereign CDS spreads by country


        **Credits:** configurable (see MACRO_* env vars)


        **Returns:** Country code, country name, CDS spread value'
      operationId: get_sovereign_cds_macro_wgb_sovereign_cds_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country name or code (partial match)
          title: Country
        description: Filter by country name or code (partial match)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/wgb/bond-spreads:
    get:
      tags:
      - macroeconomic
      summary: Get Bond Spreads
      description: 'Get 10Y bond yields and spreads vs Germany, US, China, Japan


        **Credits:** configurable (see MACRO_* env vars)


        **Returns:** Country, 10Y yield, spread vs GER/US/CN/JP (in basis points)'
      operationId: get_bond_spreads_macro_wgb_bond_spreads_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country name (partial match)
          title: Country
        description: Filter by country name (partial match)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/wgb/inverted-yields:
    get:
      tags:
      - macroeconomic
      summary: Get Inverted Yields
      description: 'Get countries with inverted yield curves grouped by credit rating


        **Credits:** configurable (see MACRO_* env vars)


        **Returns:** Rating group (e.g. A to AAA), countries grouped by inversion type'
      operationId: get_inverted_yields_macro_wgb_inverted_yields_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - APIKeyHeader: []
  /macro/wgb/yield-forecast:
    get:
      tags:
      - macroeconomic
      summary: Get Yield Forecast
      description: 'Get yield forecasts by country and maturity


        **Credits:** configurable (see MACRO_* env vars)


        **Returns:** Country, maturity, current yield, forecasted yield'
      operationId: get_yield_forecast_macro_wgb_yield_forecast_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country name (partial match)
          title: Country
        description: Filter by country name (partial match)
      - name: maturity
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by maturity (e.g. 10Y, 2Y)
          title: Maturity
        description: Filter by maturity (e.g. 10Y, 2Y)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /macro/wgb/country-detail:
    get:
      tags:
      - macroeconomic
      summary: Get Wgb Country Detail
      description: 'Get per-country bond market summary (76 countries)


        **Credits:** configurable (see MACRO_* env vars)


        **Returns:** Country slug, 10Y yield, CB rate, credit rating, CDS spread, default probability'
      operationId: get_wgb_country_detail_macro_wgb_country_detail_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by country slug (e.g. united-states, germany)
          title: Country
        description: Filter by country slug (e.g. united-states, germany)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
x-refined-from:
- fincept-in-openapi.json
- fincept-in-openapi.json
x-provenance:
  method: harvested
  publisher: Fincept Terminal
  source: https://api.fincept.in/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)