{
  "openapi": "3.1.0",
  "info": {
    "title": "Macro Index API",
    "version": "2026-10-07.44e07963",
    "description": "Neutral, cited central-bank policy rates, decision calendars, government bond auctions and issuer sources. Plain JSON with CORS; every response is {data, meta} and meta.dataset_version says what was read. A calendar date is an expectation; a decision is a fact only when observed is set. No forecasts or odds.",
    "license": {
      "name": "CC BY 4.0",
      "url": "https://creativecommons.org/licenses/by/4.0/"
    }
  },
  "servers": [
    {
      "url": "https://macroindex.org"
    }
  ],
  "paths": {
    "/v1/upcoming": {
      "get": {
        "operationId": "upcoming",
        "summary": "Decisions in a window, each with id, bank, date, announceAt, dateStatus, rateBefore (the rate going in), step, calendarSource, settleSource (the decision-statement source: pattern, foundAt, resolvable) and observed",
        "parameters": [
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD; default today",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD; default from + 60 days",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "banks",
            "in": "query",
            "required": false,
            "description": "Comma-separated bank ids",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Meetings",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/v1/banks": {
      "get": {
        "operationId": "banks",
        "summary": "Every bank with its current rate and next meeting",
        "responses": {
          "200": {
            "description": "Banks",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/v1/bank/{id}": {
      "get": {
        "operationId": "bank",
        "summary": "bank, currentRate, effective, lastDecision, nextMeeting, history facts (from observed decisions only), freshness, warnings",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "Bank id, e.g. reserve-bank-of-india",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "One bank",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/v1/bank/{id}/sources": {
      "get": {
        "operationId": "bankSources",
        "summary": "Source patterns with reads and resolvable",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "Bank id",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sources",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/v1/releases": {
      "get": {
        "operationId": "releases",
        "summary": "Inflation releases in a window",
        "parameters": [
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD; default today",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD; default from + 60 days",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Releases",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/v1/auctions": {
      "get": {
        "operationId": "auctions",
        "summary": "Government bond auctions in a window (US Treasury, German Finanzagentur and Italian Treasury, calendar and results): id, name, page (the auction’s own page on the site: there before the auction, holding only its figures), issuer, date, closeAt (bidding deadline, UTC), closeAtBasis, instrument, tenor, security (CUSIP/ISIN), size, status (scheduled, announced, held, cancelled), calendarSource, announcement, resultPage {url, format}, and result {yield, measure, price, bidToCover, allotted, at, url} only once the issuer has published it. Facts only, no forecasts; meta.dataset_version and built_at say how current the data is.",
        "parameters": [
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD; default today",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD; default from + 60 days",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "issuer",
            "in": "query",
            "required": false,
            "description": "us-treasury, de-finanzagentur or it-mef",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tenor",
            "in": "query",
            "required": false,
            "description": "e.g. 10Y, 2Y, 13W, 12M",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "instrument",
            "in": "query",
            "required": false,
            "description": "e.g. note, TIPS, Bund, BTP, BTP€i",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Auctions",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/v1/auctions/history": {
      "get": {
        "operationId": "auctionHistory",
        "summary": "Past results of one issuer, instrument and tenor, newest first: date, yield (and which measure), bid-to-cover, size, allotted, the issuer page cited (and, for Italy, the result file). Instruments never mix: a tenor with results in several instruments (US 10Y note and TIPS, Italian 10Y BTP and BTP€i) needs instrument, else 400 lists them.",
        "parameters": [
          {
            "name": "issuer",
            "in": "query",
            "required": true,
            "description": "us-treasury, de-finanzagentur or it-mef",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tenor",
            "in": "query",
            "required": true,
            "description": "e.g. 10Y, 30Y, 13W, 12M, short",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "instrument",
            "in": "query",
            "required": false,
            "description": "e.g. note, TIPS, bond, bill, FRN; Bund, Green, Bobl; BTP, BTP€i (or btpei), CCTeu, BOT. Required when the tenor has several",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Results",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/v1/health": {
      "get": {
        "operationId": "health",
        "summary": "Freshness per bank and publisher-gate warnings",
        "responses": {
          "200": {
            "description": "Health",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/v1/corrections": {
      "get": {
        "operationId": "listCorrections",
        "responses": {
          "200": {
            "description": "Public log of correction reports and their outcomes",
            "content": {
              "application/json": {}
            }
          }
        }
      },
      "post": {
        "operationId": "submitCorrection",
        "description": "Report a mistake with a URL that proves it. Public; checked like any other claim; never changes the data by itself. At most 5 per hour per client.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "claim",
                  "evidence"
                ],
                "properties": {
                  "claim": {
                    "type": "string",
                    "minLength": 10,
                    "maxLength": 2000
                  },
                  "evidence": {
                    "type": "string",
                    "format": "uri"
                  },
                  "bank": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Filed"
          },
          "400": {
            "description": "Invalid"
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    },
    "/data/dataset.json": {
      "get": {
        "operationId": "dataset",
        "summary": "The whole dataset (CC BY 4.0)",
        "responses": {
          "200": {
            "description": "Dataset",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    }
  }
}