id
from response must be used in the /download
endpoint to find the download URL.
application/json
format.
Field | Type | Required | Description | Constraints |
---|---|---|---|---|
filter/tier | integer | Yes | The data tier to be downloaded | [2, 3] |
filter/interval | string | Yes | Interval of the data | [day, month, year] |
filter/type | string | Yes | Product id of price history | [rental, retail] |
filter/period | string | Yes | Date range in YYYY/MM/DD-YYYY/MM/DD | |
paginate/num_per_page | integer | No | How many records will be return per one page, value score in 1 to 100,default value is 50 | [ 1 .. 100 ] |
paginate/page_num | integer | No | The page index number, default value is 1 | >= 1 |
order_by/period | string | No | Order of the file list | [asc, desc] |
code
in meta
indicates the error code of the request, with 0 indicating no error.id
that can be used to download the data.id
, obtained from the /list
endpoint.
application/json
format.
Field | Type | Required | Description | Constraints |
---|---|---|---|---|
id | integer | Yes | ID used for find download URL |
/list
endpoint, and then download each file using the /download
endpoint.
The required API token can be obtained through the user portal.