> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gdeltcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List FRED series

> List the FRED economic time-series catalog by title/ID search, agency, frequency, and seasonal adjustment. Call with no filters to enumerate the full curated catalog (ordered by popularity) — this is the way to discover a valid `series_id`. Quarantined (third-party copyrighted) series are never returned. See the grouped catalog: https://docs.gdeltcloud.com/api-reference/macro-series-catalog. Requires a plan with Macro & economic data access (`can_use_macro`) — the Corporate & Supply Chain and Global Intelligence plans.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/macro/series
openapi: 3.0.3
info:
  title: GDELT Cloud API v2
  version: 2.0.0
  description: >-
    Clean v2 REST API for generated GDELT Cloud structured Events, clustered
    Stories, linked Entities, summaries, admin1 discovery, significance ranking,
    and paginated article evidence.


    Event significance is a family-scoped weighted blend, renormalized so every
    event family spans a true 0-1: each event's raw total is divided by the
    maximum its own family can reach (Conflict 1.00, CAMEO+ POLITICAL 0.90,
    other CAMEO+ domains 0.65). All events: Goldstein severity 0.25, article
    evidence 0.05, confidence 0.05. Conflict only: fatalities 0.55 (log-scaled
    by body count) and civilian targeting 0.10. CAMEO+ only: magnitude 0.20,
    systemic importance 0.15, propagation potential 0.10, market sensitivity
    0.10. When magnitude is unmeasured its term AND its 0.20 weight are both
    dropped. The four CAMEO+ metrics are rubric scores produced by published
    formulas - ordinal ranking signals, not measurements, probabilities, or
    predicted price moves. goldstein_scale is one canonical public metric,
    populated for Conflict Events and CAMEO+ POLITICAL Events where meaningful.
    Story linked_event_count is a Story-to-Event link aggregate, not a distinct
    Event total.
servers:
  - url: https://gdeltcloud.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security:
  - ApiKeyAuth: []
tags:
  - name: Events
    description: Coded CAMEO+ / conflict events — search, fetch, and summarize.
  - name: Stories
    description: Clustered narratives (stories) and their articles.
  - name: Entities
    description: >-
      People & organizations — resolve a name to an entity, then fetch its
      profile and tone.
  - name: Geography
    description: Admin-1 geography lookups.
  - name: Energy
    description: Global Energy Monitor assets + ownership registry.
  - name: Facilities
    description: >-
      Unified physical-asset directory — GEM energy assets + World Port Index
      ports + Epoch AI data centers on one keyed surface, resolved to spine
      owners. Plan-gated (Analyst plan and up).
  - name: Screening and Reference
    description: >-
      Restricted-party lists, screening, and ownership-chain exposure.
      Plan-gated (`can_use_screening` / `can_use_exposure`).
  - name: China
    description: >-
      China overseas development finance (AidData GCDF). Plan-gated
      (`can_use_china`).
  - name: Media Intelligence
    description: >-
      Entity tone (`can_use_tone`) and Share of Voice (`can_use_share_of_voice`)
      are plan-gated. Social signal remains an admin-only preview.
  - name: Filings
    description: >-
      SEC EDGAR filings, XBRL financials, and AI-extracted relations. Requires a
      plan with SEC filings access (`can_use_filings`) — the Corporate & Supply
      Chain plan and above.
  - name: Macro Finance
    description: >-
      FRED economic time series (catalog, point-in-time observations, releases).
      Plan-gated (`can_use_macro`).
  - name: Maritime
    description: >-
      AIS-derived vessel-flow signals across maritime chokepoints — chokepoint
      transits, last-known vessel positions, carriers, dwell, and AIS-dark gaps.
      Plan-gated (`can_use_maritime`).
  - name: Briefs
    description: Source-backed monitoring briefs.
paths:
  /api/v2/macro/series:
    get:
      tags:
        - Macro Finance
      summary: List FRED series
      description: >-
        List the FRED economic time-series catalog by title/ID search, agency,
        frequency, and seasonal adjustment. Call with no filters to enumerate
        the full curated catalog (ordered by popularity) — this is the way to
        discover a valid `series_id`. Quarantined (third-party copyrighted)
        series are never returned. See the grouped catalog:
        https://docs.gdeltcloud.com/api-reference/macro-series-catalog. Requires
        a plan with Macro & economic data access (`can_use_macro`) — the
        Corporate & Supply Chain and Global Intelligence plans.
      operationId: list-macro-series-v2
      parameters:
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Case-insensitive match against series title or series_id.
        - name: agency
          in: query
          required: false
          schema:
            type: string
          description: >-
            Exact source agency (e.g. BLS, BEA, FRB, EIA). See [Taxonomy & Codes
            — Macro Finance](/api-reference/taxonomy#macro-finance).
        - name: frequency
          in: query
          required: false
          schema:
            type: string
            enum:
              - D
              - W
              - M
              - Q
              - A
          description: >-
            FRED frequency_short (D=Daily, W=Weekly, M=Monthly, Q=Quarterly,
            A=Annual). Case-insensitive; the word forms
            (Daily/Weekly/Monthly/Quarterly/Annual) are also accepted.
        - name: seasonal_adjustment
          in: query
          required: false
          schema:
            type: string
            enum:
              - Not Seasonally Adjusted
              - Seasonally Adjusted
              - Seasonally Adjusted Annual Rate
          description: >-
            FRED seasonal-adjustment classification. Case-insensitive; an
            unknown value returns 400 INVALID_ENUM.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: Rows per page (1–100).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Pagination cursor (offset) from a prior response's next_cursor.
      responses:
        '200':
          description: >-
            A page of series, ordered by popularity. Each row: series_id, title,
            frequency, frequency_short, units, units_short, seasonal_adjustment,
            observation_start, observation_end, source_agency, release_name,
            geo_country_iso3, compliance_status, popularity. Includes a meta
            object carrying the FRED non-endorsement attribution and source.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        series_id:
                          type: string
                        title:
                          type: string
                        frequency:
                          type: string
                        frequency_short:
                          type: string
                        units:
                          type: string
                        units_short:
                          type: string
                        seasonal_adjustment:
                          type: string
                        observation_start:
                          type: string
                        observation_end:
                          type: string
                        source_agency:
                          type: string
                        release_name:
                          type: string
                        geo_country_iso3:
                          type: string
                        compliance_status:
                          type: string
                        popularity:
                          type: integer
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      cursor: {}
                      next_cursor: {}
                  applied_filters:
                    type: object
                    properties:
                      ignored:
                        type: object
                        properties: {}
                  meta:
                    type: object
                    properties:
                      attribution:
                        type: string
                      source:
                        type: string
              examples:
                example:
                  summary: GET /api/v2/macro/series — example response
                  value:
                    success: true
                    data:
                      - series_id: DGS10
                        title: >-
                          Market Yield on U.S. Treasury Securities at 10-Year
                          Constant Maturity, Quoted on an Investment Basis
                        frequency: Daily
                        frequency_short: D
                        units: Percent
                        units_short: '%'
                        seasonal_adjustment: Not Seasonally Adjusted
                        observation_start: '1962-01-02'
                        observation_end: '2026-06-26'
                        source_agency: FRB
                        release_name: H.15 Selected Interest Rates
                        geo_country_iso3: USA
                        compliance_status: ok
                        popularity: 91
                      - series_id: UNRATE
                        title: Unemployment Rate
                        frequency: Monthly
                        frequency_short: M
                        units: Percent
                        units_short: '%'
                        seasonal_adjustment: Seasonally Adjusted
                        observation_start: '1948-01-01'
                        observation_end: '2026-05-01'
                        source_agency: BLS
                        release_name: Employment Situation
                        geo_country_iso3: USA
                        compliance_status: ok
                        popularity: 88
                    pagination:
                      limit: 25
                      cursor: null
                      next_cursor: null
                    applied_filters:
                      ignored: {}
                    meta:
                      attribution: >-
                        This product uses data from the Federal Reserve Bank of
                        St. Louis (FRED) but is not endorsed or certified by it.
                      source: Federal Reserve Bank of St. Louis (FRED)
        '401':
          description: Missing/invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Plan required (PLAN_REQUIRED) — the caller's plan does not carry the
            required source entitlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: string
        code:
          type: string
        details:
          type: object
          description: >-
            Recoverable validation context when available, such as param,
            invalid_value, accepted_values, nearest_values, and a corrected
            example.
          additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````