api-ninjas-com Interest Rate API

openapi: 3.2.0
info:
  title: Ninjas Interest Rate API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Interest Rate
  description: The Interest Rate API provides current central bank interest rates for over 2 dozen countries, major benchmark rates such as SOFR, EFFR, and EURIBOR, and bank prime / base lending rates for the US, Canada, Japan, South Africa, China, Malaysia and Brazil.
paths:
  /v2/interestrate:
    get:
      summary: Get current interest rates
      description: Returns the latest published value of a central bank or benchmark `rate`. For the full history of that rate use /historicalinterestrates.
      operationId: getCurrentInterestRates
      tags:
      - Interest Rate
      parameters:
      - $ref: '#/components/parameters/rate'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterestRateResponse'
      security:
      - ApiKeyAuth: []
  /v2/interestratehistorical:
    get:
      summary: Get historical interest rates
      description: Returns the published history of a benchmark `rate` over an optional date range, given as `start_date`/`end_date` (YYYY-MM-DD) or `start_time`/`end_time` (UNIX seconds). For the latest value only use /interestrate.
      operationId: getHistoricalInterestRates
      tags:
      - Interest Rate
      parameters:
      - $ref: '#/components/parameters/rate'
      - $ref: '#/components/parameters/InterestRateOpenapi_start_date'
      - $ref: '#/components/parameters/InterestRateOpenapi_end_date'
      - $ref: '#/components/parameters/start_time'
      - $ref: '#/components/parameters/end_time'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterestRateHistoricalResponse'
      security:
      - ApiKeyAuth: []
components:
  parameters:
    end_time:
      name: end_time
      in: query
      description: End time for the data range, specified as a UNIX timestamp in seconds. Alternative to end_date.
      required: false
      schema:
        type: integer
    InterestRateOpenapi_start_date:
      name: start_date
      in: query
      description: Start date for the data range (inclusive) in YYYY-MM-DD format, UTC. Cannot be combined with start_time.
      required: false
      schema:
        type: string
        format: date
        example: '2024-01-01'
    rate:
      name: rate
      in: query
      description: The specific interest rate identifier. Supports central bank rates (e.g. central_bank_us, central_bank_eu), benchmark rates (e.g. sofr, effr, euribor_3_months, sonia), and bank prime / base lending rates (prime_us, prime_ca, prime_jp, prime_za, lpr_cn_1y, lpr_cn_5y, br_my, blr_my, tpb_br).
      required: true
      schema:
        type: string
    start_time:
      name: start_time
      in: query
      description: Start time for the data range, specified as a UNIX timestamp in seconds. Alternative to start_date.
      required: false
      schema:
        type: integer
    page:
      name: page
      in: query
      description: Pagination cursor. Pass the `next` value from a previous response to retrieve the following page of data points.
      required: false
      schema:
        type: string
    InterestRateOpenapi_end_date:
      name: end_date
      in: query
      description: End date for the data range (inclusive) in YYYY-MM-DD format, UTC. Cannot be combined with end_time.
      required: false
      schema:
        type: string
        format: date
        example: '2024-12-31'
  schemas:
    InterestRateResponse:
      type: object
      properties:
        rate_name:
          type: string
          example: United States Prime Rate
        rate_pct:
          type: number
          example: 6.75
        last_updated:
          type:
          - string
          - 'null'
          description: Observation date of the rate.
          example: 08-13-2026
        rate_type:
          type: string
          description: What kind of instrument the rate is (e.g. bank_prime, loan_prime_rate, average_base_lending_rate). Returned for prime and base lending rates.
          example: bank_prime
        source:
          type: string
          description: The publisher of the rate. Returned for prime and base lending rates.
          example: U.S. Federal Reserve H.15 (FRED series DPRIME)
        bank_count:
          type: integer
          description: Number of banks averaged, for rates that are an average of individual banks' published rates (br_my, blr_my).
          example: 16
    InterestRateHistoricalResponse:
      type: object
      properties:
        name:
          type: string
          example: Euribor - 3 months
        data:
          type: array
          items:
            $ref: '#/components/schemas/InterestRateData'
        next:
          type:
          - string
          - 'null'
          description: Cursor for the next page of data points. Pass it back as the `page` parameter.
    InterestRateData:
      type: object
      properties:
        timestamp:
          type: integer
          description: UNIX timestamp in seconds. The time of day carries no information; use date.
          example: 1701648000
        date:
          type: string
          format: date
          description: Date the rate applies to, in YYYY-MM-DD format (UTC).
          example: '2023-12-04'
        rate_pct:
          type: number
          example: 5.62458
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api