Retrive an indicator
GET https://data.partnr.ai/v2/macroeconomics/indicators/[id]
Returns a time series of the macroeconomic indicator specified by the [id]
identifier. By default, datapoints are ordered by date, with the most recent datapoint first.
Request Parameters
Parameter | Location | Description | Required |
---|---|---|---|
[id] | URL | Id of the indicator to be queried. | Required |
start_date | Query parameter | Date to start time-series. Format: YYYY-MM-DD | Optional |
end_date | Query parameter | Date to end time-series. Format: YYYY-MM-DD | Optional |
country | Query parameter | Id of the country to query. Format: ISO 3166-1 alpha-3 | Optional |
unit | Query parameter | Unit of the indicators to query. | Optional |
limit | Query parameter | Quantity of datapoints to return. Default: 100 | Optional |
Response
Code | Description |
---|---|
200 | Returns the indicator's time series. |
404 | The indicator was not found. |
401 | Unauthorized. |
Example
[
{
"date": "2022-03-01T00:00:00.000Z",
"type": "INFLATION_RATE",
"unit": "MONTHLY",
"country": "BRA",
"value": 1.62
},
{
"date": "2022-02-01T00:00:00.000Z",
"type": "INFLATION_RATE",
"unit": "MONTHLY",
"country": "BRA",
"value": 1.01
},
{
"date": "2022-01-01T00:00:00.000Z",
"type": "INFLATION_RATE",
"unit": "MONTHLY",
"country": "BRA",
"value": 0.54
}
]