Skip to main content
POST
/
api
/
bis
/
datasets
/bis/datasets
curl --request POST \
  --url https://api.anysite.io/api/bis/datasets \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "dataset": "<string>",
  "count": 2,
  "timeout": 300,
  "agency": "BIS",
  "version": "1.0",
  "filters": {
    "FREQ": [
      "M"
    ],
    "REF_AREA": [
      "US"
    ]
  },
  "since": "2020",
  "until": "2024",
  "last_n_observations": 10,
  "first_n_observations": 10
}
'
[
  {
    "dimensions": [
      {
        "id": "<string>",
        "code": "<string>",
        "@type": "@bis_observation_dimension"
      }
    ],
    "time": "<string>",
    "value": 123,
    "@type": "@bis_observation",
    "status": "<string>",
    "confidentiality": "<string>",
    "title": "<string>",
    "source_ref": "<string>",
    "compilation": "<string>",
    "unit_measure": "<string>",
    "unit_mult": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
dataset
string
required

Dataset id

Examples:

"WS_CBPOL"

"WS_TC"

"WS_EER"

​
count
integer
required

Number of observations to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
agency
string
default:BIS

Maintenance agency id

Example:

"BIS"

​
version
string
default:1.0

Dataset version

Example:

"1.0"

​
filters
Filters · object

Dimension filters as a mapping of dimension id to allowed value codes

Example:
{ "FREQ": ["M"], "REF_AREA": ["US"] }
​
since
string | null

Earliest time period, inclusive

Example:

"2020"

​
until
string | null

Latest time period, inclusive

Example:

"2024"

​
last_n_observations
integer | null

Return only the latest N observations of each series

Required range: x >= 1
Example:

10

​
first_n_observations
integer | null

Return only the earliest N observations of each series

Required range: x >= 1
Example:

10

Response

Successful Response

​
dimensions
BisObservationDimension · object[]
required
​
time
string
required
​
value
required
​
@type
string
default:@bis_observation
​
status
string | null
​
confidentiality
string | null
​
title
string | null
​
source_ref
string | null
​
compilation
string | null
​
unit_measure
string | null
​
unit_mult
string | null