For the complete documentation index, see llms.txt. This page is also available as Markdown.

REST API

Get FAST Taxonomy

get

Get the taxonomy id and the list of assets the authenticated user is authorized to receive. The numeric asset_id returned for each asset is scoped to the returned taxonomy_id.

Authorizations
AuthorizationstringRequired

Enter your token in the format of "Basic your-token"

Responses
200

OK

application/json
taxonomy_idinteger · int32 · max: 65535Required

Identifier for a FAST taxonomy. Stable for the lifetime of a deployment.

Example: 1
get/v1/taxonomy
GET /v1/taxonomy HTTP/1.1
Host: fast.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*
{
  "taxonomy_id": 1,
  "assets": [
    {
      "name": "BTCUSD",
      "asset_id": 0
    },
    {
      "name": "ETHUSD",
      "asset_id": 1
    },
    {
      "name": "SOLUSD",
      "asset_id": 2
    }
  ]
}

Get Latest Prices

get

Get the most recent prices for one or more assets as a FAST message. Assets are identified by their numeric FAST asset ids (scoped to the current taxonomy returned by /v1/taxonomy). The response is the FAST wire payload encoded as JSON.

The message_type query parameter selects the wire format:

  • unsigned (default) — taxonomy, timestamp, and quantized values per asset.

  • signed_ecdsa — same as unsigned plus a hex-encoded ECDSA payload (p) covering the assets list, taxonomy id, and timestamp.

Quantized values (v) are decimal strings scaled by 1e18.

Authorizations
AuthorizationstringRequired

Enter your token in the format of "Basic your-token"

Query parameters
assetsstringRequired

Comma-separated list of FAST asset ids to fetch (e.g. 1,2,3).

Example: 1,2
message_typestring · enumOptional

Wire format for the response payload.

Default: unsignedPossible values:
Responses
200

OK

application/json
or
get/v1/prices/latest
GET /v1/prices/latest?assets=text HTTP/1.1
Host: fast.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*
{
  "type": "unsigned",
  "tax": 1,
  "ts": 1717331200000000000,
  "a": [
    {
      "id": 1,
      "v": "100000000000000000000"
    },
    {
      "id": 2,
      "v": "3500000000000000000000"
    }
  ]
}

Get Market Status

get

Get the current market status, next market status, and the time of the next status change for a FAST-tracked asset, identified by its numeric FAST asset id.

The response is an unsigned JSON object with Fast-style short keys:

  • a — the requested FAST asset id

  • ts — request timestamp in nanoseconds

  • cs — current status code

  • ns — next status code

  • chts — timestamp of the next status change in nanoseconds

Status codes:

Code
Meaning

0

Closed

1

Regular Hours

2

Extended Hours

3

After Hours

Supported asset classes: US equities (e.g. AAPL_24_5, TSLA_24_5), forex pairs (e.g. EURUSD, USDJPY), and metals (XAUUSD, XAGUSD).

Authorizations
AuthorizationstringRequired

Enter your token in the format of "Basic your-token"

Query parameters
assetinteger · int32 · max: 65535Required

Compact numeric asset id used inside FAST messages.

Example: 42
Responses
200

OK

application/json
ainteger · int32 · max: 65535Required

Compact numeric asset id used inside FAST messages.

Example: 42
tsinteger · int64Required

Request timestamp in nanoseconds since the Unix epoch.

Example: 1780000669496111000
csinteger · enumRequired

Market status code:

  • 0 — Closed
  • 1 — Regular Hours
  • 2 — Extended Hours
  • 3 — After Hours
Example: 1Possible values:
nsinteger · enumRequired

Market status code:

  • 0 — Closed
  • 1 — Regular Hours
  • 2 — Extended Hours
  • 3 — After Hours
Example: 1Possible values:
chtsinteger · int64Required

Timestamp of the next status change in nanoseconds since the Unix epoch.

Example: 1780000669496111000
get/v1/market_status
GET /v1/market_status?asset=42 HTTP/1.1
Host: fast.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*
{
  "a": 42,
  "ts": 1780000669496111000,
  "cs": 1,
  "ns": 0,
  "chts": 1780000669496111000
}

Last updated