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

REST API

Real-Time and historical Data API for Stork signed data.

Authentication

All REST requests must include an Authorization header with the value set as Basic <token> . For example if your token is gmork123:

curl -X GET 'https://rest.jp.stork-oracle.network/v1/prices/assets' -H "Authorization: Basic gmork123"

Rate Limits

There is currently a universal rate limit of 5 requests/sec.

Need a higher rate limit? Reach out to Stork. sales@stork.network or Twitter DMs open.

Note

This tool is meant to illustrate the structure of REST api responses, but unfortunately due to third party limitations, some loss of precision on large numbers may be experienced in the browser. If you wish to test the verifiability of Stork prices from the REST api, we recommend using CURL to view the raw response.

List Available Assets

get

Get the list of available asset IDs.

Authorizations
AuthorizationstringRequired

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

Responses
200

OK

application/json
datastring[]Optional

A unique identifier for an asset.

Example: BTCUSD
get/v1/prices/assets
GET /v1/prices/assets HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    "BTCUSD"
  ]
}

Get Latest Prices

get

Get latest real-time prices for specified assets.

Authorizations
AuthorizationstringRequired

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

Query parameters
assetsstringRequired

Comma-separated list of asset symbols (e.g. BTCUSD,ETHUSD)

Responses
200

OK

application/json
get/v1/prices/latest
GET /v1/prices/latest?assets=text HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "value": {
      "BTCUSD": {
        "timestamp": 1745436557621941000,
        "asset_id": "BTCUSD",
        "signature_type": "evm",
        "trigger": "unspecified",
        "price": "93034248063749982000000",
        "stork_signed_price": {
          "public_key": "0x3db9E960ECfCcb11969509FAB000c0c96DC51830",
          "encoded_asset_id": "0x7404e3d104ea7841c3d9e6fd20adfe99b4ad586bc08d8f3bd3afef894cf184de",
          "price": "93034248063749982000000",
          "timestamped_signature": {
            "signature": {
              "r": "0xb8e46bc91712ee9a1d5f163c4a25d6cbbf6660dc8e2dcdfafb19d89cdc87f3b3",
              "s": "0x69b91a8412e19f90f4cd34e800e34b3702cd93169994bf9d75b20029458bce93",
              "v": "0x1c"
            },
            "timestamp": 1745436557678933200,
            "msg_hash": "0xa71936d99252e6b430fbb0b82a86a90ee03ab21ab6cdb9b7ce7762f3b19082c1"
          },
          "publisher_merkle_root": "0xb85ded8bf6d17f5040fba3f92e4ea0cd4dd94ff96f88389ac997f2f869cfc7de",
          "calculation_alg": {
            "type": "median",
            "version": "v1",
            "checksum": "9be7e9f9ed459417d96112a7467bd0b27575a2c7847195c68f805b70ce1795ba"
          }
        },
        "signed_prices": [
          {
            "publisher_key": "0x60684C26449D2987F21Cf2E4D66716AE2B09Ea30",
            "external_asset_id": "BTCUSD",
            "signature_type": "evm",
            "price": "93034248063749982000000",
            "timestamped_signature": {
              "signature": {
                "r": "0xe5001b90d6dbba8a50cb0b842e2a4fbbc9ba778c5dd6eaf7e55656149adc2e94",
                "s": "0x2032f85009051f061fddfef527f316a4b29c4ff754016e083936a8ae87fecc36",
                "v": "0x1c"
              },
              "timestamp": 1745436557621941000,
              "msg_hash": "0xa749104b6864c0518ab4f4c6e3e09759f0620ae3895f9fea30fc618d1801f706"
            }
          },
          {
            "publisher_key": "0xdE54a40A841d0764966B89bBE5d71c5189122AA3",
            "external_asset_id": "BTCUSD",
            "signature_type": "evm",
            "price": "93034248063749982000000",
            "timestamped_signature": {
              "signature": {
                "r": "0xe33549245979112871b699f30199d7f6ffce0472e47561610ac91abbdd32d504",
                "s": "0x375d91724aa3741d34e305e135d695f39d33285669c1484978cd27e64f84b363",
                "v": "0x1b"
              },
              "timestamp": 1745436557621941000,
              "msg_hash": "0xfaac8ea9c656d7e8f997bedb8dfe9822946c18fba4bd1b74fb23b9c537f5bcf2"
            }
          }
        ]
      }
    }
  }
}

Get Recent Prices

get

Get signed prices for specified assets at a specific timestamp within the last 10 minutes.

Authorizations
AuthorizationstringRequired

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

Query parameters
timestampinteger · int64Required

Unix timestamp in seconds

assetsstringRequired

Comma-separated list of asset symbols (e.g. BTCUSD,ETHUSD)

Responses
200

OK

application/json
get/v1/prices/recent
GET /v1/prices/recent?timestamp=1&assets=text HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "value": {
      "BTCUSD": {
        "timestamp": 1745436557621941000,
        "asset_id": "BTCUSD",
        "signature_type": "evm",
        "trigger": "unspecified",
        "price": "93034248063749982000000",
        "stork_signed_price": {
          "public_key": "0x3db9E960ECfCcb11969509FAB000c0c96DC51830",
          "encoded_asset_id": "0x7404e3d104ea7841c3d9e6fd20adfe99b4ad586bc08d8f3bd3afef894cf184de",
          "price": "93034248063749982000000",
          "timestamped_signature": {
            "signature": {
              "r": "0xb8e46bc91712ee9a1d5f163c4a25d6cbbf6660dc8e2dcdfafb19d89cdc87f3b3",
              "s": "0x69b91a8412e19f90f4cd34e800e34b3702cd93169994bf9d75b20029458bce93",
              "v": "0x1c"
            },
            "timestamp": 1745436557678933200,
            "msg_hash": "0xa71936d99252e6b430fbb0b82a86a90ee03ab21ab6cdb9b7ce7762f3b19082c1"
          },
          "publisher_merkle_root": "0xb85ded8bf6d17f5040fba3f92e4ea0cd4dd94ff96f88389ac997f2f869cfc7de",
          "calculation_alg": {
            "type": "median",
            "version": "v1",
            "checksum": "9be7e9f9ed459417d96112a7467bd0b27575a2c7847195c68f805b70ce1795ba"
          }
        },
        "signed_prices": [
          {
            "publisher_key": "0x60684C26449D2987F21Cf2E4D66716AE2B09Ea30",
            "external_asset_id": "BTCUSD",
            "signature_type": "evm",
            "price": "93034248063749982000000",
            "timestamped_signature": {
              "signature": {
                "r": "0xe5001b90d6dbba8a50cb0b842e2a4fbbc9ba778c5dd6eaf7e55656149adc2e94",
                "s": "0x2032f85009051f061fddfef527f316a4b29c4ff754016e083936a8ae87fecc36",
                "v": "0x1c"
              },
              "timestamp": 1745436557621941000,
              "msg_hash": "0xa749104b6864c0518ab4f4c6e3e09759f0620ae3895f9fea30fc618d1801f706"
            }
          },
          {
            "publisher_key": "0xdE54a40A841d0764966B89bBE5d71c5189122AA3",
            "external_asset_id": "BTCUSD",
            "signature_type": "evm",
            "price": "93034248063749982000000",
            "timestamped_signature": {
              "signature": {
                "r": "0xe33549245979112871b699f30199d7f6ffce0472e47561610ac91abbdd32d504",
                "s": "0x375d91724aa3741d34e305e135d695f39d33285669c1484978cd27e64f84b363",
                "v": "0x1b"
              },
              "timestamp": 1745436557621941000,
              "msg_hash": "0xfaac8ea9c656d7e8f997bedb8dfe9822946c18fba4bd1b74fb23b9c537f5bcf2"
            }
          }
        ]
      }
    }
  }
}

Get Historical Price Metrics

get

Get OHLC price data for a specific asset within a time range.

Authorizations
AuthorizationstringRequired

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

Query parameters
fromintegerRequired

Start timestamp (Unix seconds)

tointegerRequired

Start timestamp (Unix seconds)

resolutionstring · enumRequired

Time resolution in minutes, or 1 day, 1 week, or 1 month.

Possible values:
symbolstringRequired

A unique identifier for an asset.

Example: BTCUSD
Responses
200

OK

application/json
get/v1/tradingview/history
GET /v1/tradingview/history?from=1&to=1&resolution=1&symbol=BTCUSD HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "data": {
    "t": [
      1745440680,
      1745440740
    ],
    "o": [
      93844.72017265,
      93823.3268325
    ],
    "h": [
      93844.72017265,
      93826.57309804998
    ],
    "l": [
      93819.18021595,
      93777.20385154997
    ],
    "c": [
      93823.3268325,
      93777.20385154997
    ]
  }
}

Get Market State Change Info

get

Get the current market status, next market status, and the time of the next status change for a given asset. Returns three values keyed by synthetic asset IDs:

  • {asset_id}_CURRENT_STATUS — current market status code

  • {asset_id}_NEXT_STATUS — next market status code

  • {asset_id}_CHANGE_TIME — Unix timestamp (seconds) of the next status change

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).

This endpoint only applies to assets with variable trading schedules. Crypto and other 24/7 assets (e.g. BTCUSD, PAXGUSD) are not supported.

Authorizations
AuthorizationstringRequired

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

Query parameters
asset_idstringRequired

An asset with a variable trading schedule. Supported asset classes are US equities (e.g. AAPL_24_5), forex pairs (e.g. EURUSD), and metals (XAUUSD, XAGUSD). Crypto and other 24/7 assets are not supported.

Example: AAPL_24_5
Responses
200

OK

application/json
get/v1/market_status
GET /v1/market_status?asset_id=AAPL_24_5 HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "AAPL_24_5_CURRENT_STATUS": {
      "timestamp": 1745436557621941000,
      "asset_id": "AAPL_24_5_CURRENT_STATUS",
      "signature_type": "evm",
      "trigger": "api_request",
      "price": "1",
      "stork_signed_price": {
        "encoded_asset_id": "0x1234567890abcdef",
        "price": "1",
        "timestamped_signature": {
          "timestamp": 1745436557621941000
        }
      },
      "signed_prices": []
    },
    "AAPL_24_5_NEXT_STATUS": {
      "timestamp": 1745436557621941000,
      "asset_id": "AAPL_24_5_NEXT_STATUS",
      "signature_type": "evm",
      "trigger": "api_request",
      "price": "0",
      "stork_signed_price": {
        "encoded_asset_id": "0xfedcba0987654321",
        "price": "0",
        "timestamped_signature": {
          "timestamp": 1745436557621941000
        }
      },
      "signed_prices": []
    },
    "AAPL_24_5_CHANGE_TIME": {
      "timestamp": 1745436557621941000,
      "asset_id": "AAPL_24_5_CHANGE_TIME",
      "signature_type": "evm",
      "trigger": "api_request",
      "price": "1745460000",
      "stork_signed_price": {
        "encoded_asset_id": "0xabcdef1234567890",
        "price": "1745460000",
        "timestamped_signature": {
          "timestamp": 1745436557621941000
        }
      },
      "signed_prices": []
    }
  }
}

List EVM chain Deployments

get

Get the list of EVM chain deployments and their details.

Responses
200

OK

application/json
get/v1/deployments/evm
GET /v1/deployments/evm HTTP/1.1
Host: rest.jp.stork-oracle.network
Accept: */*
200

OK

{
  "data": [
    {
      "chain_id": 50401,
      "network": "Sophon",
      "environment": "Mainnet",
      "proxy_address": "0x6a2ab154d7c5Ba9fdea6d8A0C79818A4463a63f9",
      "block_explorer_url": "https://explorer.sophon.xyz/"
    }
  ]
}

[Alpha] List assets being pushed on-chain by Stork

get

[Alpha] List assets and their configuration details being pushed on-chain by Stork Labs by chain and environment.

Authorizations
AuthorizationstringRequired

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

Responses
200

OK

application/json
get/v0/deployments/stork_pushed_assets
GET /v0/deployments/stork_pushed_assets HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Ethereum": {
    "mainnet": {
      "BTCUSD": {
        "delta": 0.1,
        "staleness": 60
      }
    }
  }
}
PreviousSubscriber
NextContract APIs

Last updated