openapi: 3.1.0
info:
  title: US CPI Data & Inflation Report
  description: Gives you official United States inflation numbers from the government's BLS Consumer Price Index. Ask for
    the newest reading, a specific month in the past, or a whole range of months, and get back clear percentages for overall
    inflation and 'core' inflation (which ignores food and energy prices), plus a plain-English summary sentence.
  version: 1.0.0
  contact:
    name: _done
    url: https://forms.gle/5KzuSFH7p8hHtDmz7
    email: info@underscoredone.com
  x-openapi-url: https://cpi-report-us.underscoredone.com/openapi.json
  x-logo:
    url: https://underscoredone.com/logo.png
    altText: _done
  x-guidance: Send an empty body for the newest available inflation report. Send 'period' as YYYY-MM to get one specific historical
    month. Send 'start' and/or 'end' as YYYY-MM to get a series of months for charting or analysis; omitting both start and
    end while providing neither period returns the newest single report. Do not send 'period' together with 'start'/'end'
    — 'period' takes priority and a range will not be returned. Treat any rate field that comes back as null as simply unavailable
    for that month, not an error.
  x-ai-instructions: Send an empty body for the newest available inflation report. Send 'period' as YYYY-MM to get one specific
    historical month. Send 'start' and/or 'end' as YYYY-MM to get a series of months for charting or analysis; omitting both
    start and end while providing neither period returns the newest single report. Do not send 'period' together with 'start'/'end'
    — 'period' takes priority and a range will not be returned. Treat any rate field that comes back as null as simply unavailable
    for that month, not an error.
  x-provider: _done — single-purpose utility APIs for developers and AI agents. Pay per call with USDC on Base Mainnet or
    Solana Mainnet.
  x-pricing:
    model: pay-per-call
    currency: USDC
    network: Base Mainnet or Solana Mainnet
    price: $0.01
  x-keywords:
  - cpi report
  - cpi consumer price index
  - consumer index number
  - consumer index price
  - consumer index rate
  - consumer price index figures
  - cpi index report
  - cpi price index
  - current price index
  - price index consumer
  - inflation report
  - cpi inflation figures
  - cpi data
  - consumer price index data
  - cpi database
  - cpi index data
  - data cpi
  - inflation statistics by year
  - consumer index inflation
  - inflation consumer price index
  - inflation price index
  - cpi report today
  - inflation data
  - cpi inflation report
  - consumer price index report today
  - cpi inflation reports
  - inflation report today
  - current consumer price index
  - current rate of cpi
  - present consumer price index
  - recent consumer price index
  - cpi inflation data
  - monthly inflation data
  - consumer price inflation data
  - cpi data release
  - bureau of labor statistics consumer price index
  - bureau of labor statistics cpi
  - consumer price index latest
  - consumer price index today
  - cpi release date
  - inflation numbers
  - inflation data today
  - consumer price index chart
  - consumer index chart
  - consumer price index graph
  - consumer price index u
  - historical inflation numbers
  - fred data cpi
  - price index numbers
  - latest inflation numbers
  - latest inflation data
  - annual inflation data
  - annual inflation figures
  - consumer price index numbers
  - cpi data release today
  - cpi data today
  - consumer price index release
  - cpi index release
  - cpi release
  - real inflation numbers
  - cpi history
  - consumer price index history
  - inflation numbers today
  - cpi report date
  - today's inflation report
  - cpi report release
  - cpi date
  - consumer price index cpi rates
  - consumer price index rate
  - inflation trends
  - latest inflation report
  - consumer price index in economics
  - consumer price index tables
  - historic inflation rates chart
  - inflation statistics
  - inflation data release
  - june inflation report
  - latest cpi report
  - usd cpi data
  - today's cpi report
  - cpi numbers today
  - consumer indexes
  - consumer price index inflation chart
  - inflation cpi chart
  - april inflation report
  - bls cpi data
  - consumer price index trend
  - cpi historical values
  - cpi release time
  - cpi report time
  - cpi trends
  - september inflation report
  - consumer price index historical chart
  - consumer price index historical graph
  - consumer price index history chart
  - consumer price index history graph
  - consumer price index values
  - cpi historical by year
  - cpi historical chart
  - dates
  - cpi
  - cpi report us
  - inflation
  - consumer price index
  - bls
  - economic data
  - inflation rate
  - core inflation
  - macro data
  - historical inflation
  - utility
  - api
  - ai-agent
  - pay-per-call
  - usdc
  - x402
  x-category: data
  x-provider-url: https://underscoredone.com
  x-agentcash-auth:
    mode: paid
  x-402:
    price: $0.01
    network: eip155:8453
    asset: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'
    pay_to: '0xE9740820225B3918b4ddd1292C7cA4Ca0e2C2F08'
    facilitator: https://api.cdp.coinbase.com/platform/v2/x402
    scheme: exact
    description: Gives you official United States inflation numbers from the government's BLS Consumer Price Index. Ask for
      the newest reading, a specific month in the past, or a whole range of months, and get back clear percentages for overall
      inflation and 'core' inflation (which ignores food and energy prices), plus a plain-English summary sentence.
    mime_type: application/json
    networks:
    - network: eip155:8453
      asset: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'
      pay_to: '0xE9740820225B3918b4ddd1292C7cA4Ca0e2C2F08'
    - network: solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
      asset: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
      pay_to: 8ugAWAXDB8V18kiUrGZTq1oMvU3C6Fxs8hfC6rvzQT3b
paths:
  /cpi:
    post:
      tags:
      - data
      - cpi
      - inflation
      - consumer price index
      - bls
      - us inflation rate
      - core inflation
      - cpi report
      - bls cpi
      - inflation data
      - headline inflation
      - inflation rate
      - cost of living
      - price index
      - economic indicators
      - macro data
      summary: Latest, single-month, or ranged US CPI inflation data from BLS with plain-English summary.
      description: Looks up official United States inflation figures from BLS. Send nothing for the newest month on record,
        a 'period' for one specific month, or a 'start'/'end' pair for a range of months.
      operationId: handler_cpi_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Request'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              examples:
                success:
                  summary: Successful response
                  value:
                    api_version: 1.0.0
        '422':
          description: Unprocessable — a required field is missing or the wrong type. Check the detail field for specifics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: array
        '402':
          description: Payment required. Send a signed USDC payment on Base Mainnet or Solana Mainnet using the x402 protocol.
          headers:
            X-Payment-Response:
              description: x402 payment challenge — base64-encoded JSON with payment details.
              schema:
                type: string
        '400':
          description: Bad request — your input failed validation or could not be processed. Check the detail field for specifics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
      x-ai-instructions: Send an empty body for the newest available inflation report. Send 'period' as YYYY-MM to get one
        specific historical month. Send 'start' and/or 'end' as YYYY-MM to get a series of months for charting or analysis;
        omitting both start and end while providing neither period returns the newest single report. Do not send 'period'
        together with 'start'/'end' — 'period' takes priority and a range will not be returned. Treat any rate field that
        comes back as null as simply unavailable for that month, not an error.
      x-guidance: Send an empty body for the newest available inflation report. Send 'period' as YYYY-MM to get one specific
        historical month. Send 'start' and/or 'end' as YYYY-MM to get a series of months for charting or analysis; omitting
        both start and end while providing neither period returns the newest single report. Do not send 'period' together
        with 'start'/'end' — 'period' takes priority and a range will not be returned. Treat any rate field that comes back
        as null as simply unavailable for that month, not an error.
      x-payment-info:
        price:
          fixed:
            mode: fixed
            currency: USD
            amount: '0.01'
        protocols:
        - x402: {}
components:
  schemas:
    CpiRecord:
      properties:
        reference_period:
          type: string
          title: Reference Period
          description: The month this data covers, shown as year-month.
        headline_index:
          type: number
          title: Headline Index
          description: The overall price index number for this month.
        core_index:
          type: number
          title: Core Index
          description: The price index number for this month, leaving out food and energy prices.
        headline_yoy_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Headline Yoy Pct
          description: How much overall prices rose compared to the same month one year earlier, as a percent. Blank if not
            enough history exists yet.
        core_yoy_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Core Yoy Pct
          description: How much prices rose compared to the same month one year earlier, leaving out food and energy, as a
            percent. Blank if not enough history exists yet.
      type: object
      required:
      - reference_period
      - headline_index
      - core_index
      title: CpiRecord
      example:
        core_index: 313.5
        core_yoy_pct: 3.3
        headline_index: 314.796
        headline_yoy_pct: 3.4
        reference_period: 2024-03
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Request:
      properties:
        period:
          anyOf:
          - type: string
            maxLength: 7
          - type: 'null'
          title: Period
          description: A single month to look up, written as year-month, like 2024-03. Leave this out if you want the newest
            data or a range instead.
        start:
          anyOf:
          - type: string
            maxLength: 7
          - type: 'null'
          title: Start
          description: The first month of a historical range, written as year-month, like 2023-01. Leave out to start from
            the earliest available month.
        end:
          anyOf:
          - type: string
            maxLength: 7
          - type: 'null'
          title: End
          description: The last month of a historical range, written as year-month, like 2024-12. Leave out to end at the
            newest available month.
      type: object
      title: Request
      example:
        period: 2024-03
    Response:
      properties:
        api_version:
          type: string
          title: Api Version
          description: API version
          default: 1.0.0
        reference_period:
          anyOf:
          - type: string
          - type: 'null'
          title: Reference Period
          description: The single month this data covers, shown as year-month. Only present for single-month requests.
        headline_index:
          anyOf:
          - type: number
          - type: 'null'
          title: Headline Index
          description: The overall price index number for the requested month. Only present for single-month requests.
        core_index:
          anyOf:
          - type: number
          - type: 'null'
          title: Core Index
          description: The price index number for the requested month, leaving out food and energy prices. Only present for
            single-month requests.
        headline_yoy_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Headline Yoy Pct
          description: How much overall prices rose compared to the same month one year earlier, as a percent. Only present
            for single-month requests.
        core_yoy_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Core Yoy Pct
          description: How much prices rose compared to the same month one year earlier, leaving out food and energy, as a
            percent. Only present for single-month requests.
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
          description: A plain-English sentence describing the inflation figures.
        data:
          anyOf:
          - items:
              $ref: '#/components/schemas/CpiRecord'
            type: array
          - type: 'null'
          title: Data
          description: A list of monthly figures, one entry per month, in chronological order. Only present when a range of
            months was requested.
        count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Count
          description: How many months are included in the data list. Only present when a range of months was requested.
      type: object
      title: Response
      example:
        api_version: 1.0.0
        core_index: 313.5
        core_yoy_pct: 3.3
        headline_index: 314.796
        headline_yoy_pct: 3.4
        reference_period: 2024-03
        summary: In 2024-03, prices overall were up 3.4% compared to a year earlier, and core prices (excluding food and energy)
          were up 3.3% compared to a year earlier.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    siwx:
      type: apiKey
      in: header
      name: SIGN-IN-WITH-X
      description: CAIP-122 wallet signature for repeat access after payment
servers:
- url: https://cpi-report-us.underscoredone.com
  description: Production
tags:
- name: data
- name: cpi
- name: inflation
- name: consumer price index
- name: bls
- name: us inflation rate
- name: core inflation
- name: cpi report
- name: bls cpi
- name: inflation data
- name: headline inflation
- name: inflation rate
- name: cost of living
- name: price index
- name: economic indicators
- name: macro data
x402Version: 2
x-payment-accepts:
- scheme: exact
  network: eip155:8453
  payTo: '0xE9740820225B3918b4ddd1292C7cA4Ca0e2C2F08'
  asset: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'
- scheme: exact
  network: solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
  payTo: 8ugAWAXDB8V18kiUrGZTq1oMvU3C6Fxs8hfC6rvzQT3b
  asset: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v