Get Data Request

GET 
/api/v1/historical-data/:requestId

This endpoint allows you to check the status of a data request.

Request

Path Parameters

requestId integerrequired

Possible values: > 0

ID of the Request

Responses

200

Success

application/json

Schema

Schema

oneOf

MOD1

Data request failed

requestId integerrequired

ID of the Request

Possible values: > 0

Example: 1000

status stringrequired

Possible values: [Failed]

error stringrequired

Possible values: [Data request failed, Request timed out]

MOD2

Data request is still running

requestId integerrequired

ID of the Request

Possible values: > 0

Example: 1000

status stringrequired

Possible values: [Running]

outputFile urirequired

URL to download the data output file

Example: https://nortech-api-query-euc1.s3.eu-central-1.amazonaws.com/User-10-1713999600/000.parquet

MOD3

Data request is finished

requestId integerrequired

ID of the Request

Possible values: > 0

Example: 1000

status stringrequired

Possible values: [Finished]

outputFile urirequired

URL to download the data output file

Example: https://nortech-api-query-euc1.s3.eu-central-1.amazonaws.com/User-10-1713999600/000.parquet

Example (from schema)

{}

400

Validation Error

application/json

Schema

Schema

status stringrequired

Possible values: [Validation Error]

errors

object[]

required

Array [

error stringrequired

location stringrequired

Possible values: [body, query, path, headers]

]

Example (from schema)

{
  "status": "Validation Error",
  "errors": [
    {
      "error": "string",
      "location": "body"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

status stringrequired

Possible values: [Unauthorized]

Example (from schema)

{
  "status": "Unauthorized"
}

404

Request not found

application/json

Schema

Schema

status stringrequired

Possible values: [Request not found]

Example (from schema)

{
  "status": "Request not found"
}

Loading...