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

PreviousSubscriber NextContract APIs

Last updated 23 days ago

List Available Assets

Get the list of available asset IDs.

get

/prices/assets

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://rest.jp.stork-oracle.network/v1/prices/assets'

200

404

{
  "data": [
    "BTCUSD"
  ]
}

Get Latest Prices

Get latest real-time prices for specified assets.

get

/prices/latest

Authorizations

Query parameters

assetsstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://rest.jp.stork-oracle.network/v1/prices/latest?assets=text' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{
  "data": [
    {
      "timestamp": 1734127259251174100,
      "asset_id": "BTCUSD",
      "signature_type": "evm",
      "trigger": "unspecified",
      "price": "101344782928537490000000",
      "stork_signed_price": {
        "public_key": "0x0a803F9b1CCe32e2773e0d2e98b37E0775cA5d44",
        "encoded_asset_id": "0x7404e3d104ea7841c3d9e6fd20adfe99b4ad586bc08d8f3bd3afef894cf184de",
        "price": "101344782928537490000000",
        "timestamped_signature": {
          "timestamp": 1734127259251174100,
          "msg_hash": "0x977891628f4fc326f858ec33ba03da335e2ec4648a9f9332ab0317a64165fa7c",
          "signature": {
            "r": "0xb193e9ff3e3c0346ca74e194b8eab13cc9d49b73a68167b7a021ec979cb3aef7",
            "s": "0x07a7176c245e24777755ae3037450862bb4dbc1e4ff49304cd82c3d818a8e598",
            "v": "0x1b"
          }
        },
        "publisher_merkle_root": "0x4e0a03960cea21f67d7f2b66c5457fa4fea3632a68d0f3bc01adb0588446efdf",
        "calculation_alg": {
          "version": "v1",
          "checksum": "9be7e9f9ed459417d96112a7467bd0b27575a2c7847195c68f805b70ce1795ba",
          "type": "median"
        }
      },
      "signed_prices": [
        {
          "publisher_key": "0x51aa9e9C781F85a2C0636A835EB80114c4553098",
          "external_asset_id": "BTCUSD",
          "signature_type": "evm",
          "price": "101344782928537490000000",
          "timestamped_signature": {
            "timestamp": 1734127259251174100,
            "msg_hash": "0x977891628f4fc326f858ec33ba03da335e2ec4648a9f9332ab0317a64165fa7c",
            "signature": {
              "r": "0xb193e9ff3e3c0346ca74e194b8eab13cc9d49b73a68167b7a021ec979cb3aef7",
              "s": "0x07a7176c245e24777755ae3037450862bb4dbc1e4ff49304cd82c3d818a8e598",
              "v": "0x1b"
            }
          },
          "metadata": null
        }
      ]
    }
  ]
}

Get Historical Price Metrics

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

get

/tradingview/history

Authorizations

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.

Options: 1, 2, 5, 15, 30, 60, 120, 240, 360, 720, D, 1D, W, 1W, M, 1M

symbolstringrequired

A unique identifier for an asset.

Example: BTCUSD

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://rest.jp.stork-oracle.network/v1/tradingview/history?from=1&to=1&resolution=1&symbol=BTCUSD' \
  --header 'Authorization: YOUR_API_KEY'

200

No body

successful operation

List EVM chain Deployments

Get the list of EVM chain deployments and their details.

get

/deployments/evm

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://rest.jp.stork-oracle.network/v1/deployments/evm'

200

404

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

Get Implied Volatility

Get signed implied volatility data for a specific option.

get

/options/implied_volatility

Authorizations

Query parameters

symbolstringrequired

Asset symbol (e.g. BTCUSD)

expirystring · daterequired

Option expiry date in YYYY-MM-DD format

strikestringrequired

Strike price in USD

typestring · enumrequired

Option type (PUT or CALL)

Options: PUT, CALL

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://rest.jp.stork-oracle.network/v1/options/implied_volatility?symbol=text&expiry=2025-02-22&strike=text&type=PUT' \
  --header 'Authorization: YOUR_API_KEY'

200

400

500

{
  "symbol": "BTCUSD",
  "expiry": "2024-12-31",
  "strike": "50000",
  "timestamp": 1,
  "stork_signed_implied_volatility": {
    "public_key": "0x0a803F9b1CCe32e2773e0d2e98b37E0775cA5d44",
    "encoded_asset_id": "0x7404e3d104ea7841c3d9e6fd20adfe99b4ad586bc08d8f3bd3afef894cf184de",
    "price": "101344782928537490000000",
    "timestamped_signature": {
      "timestamp": 1734127259251174100,
      "msg_hash": "0x977891628f4fc326f858ec33ba03da335e2ec4648a9f9332ab0317a64165fa7c",
      "signature": {
        "r": "0xb193e9ff3e3c0346ca74e194b8eab13cc9d49b73a68167b7a021ec979cb3aef7",
        "s": "0x07a7176c245e24777755ae3037450862bb4dbc1e4ff49304cd82c3d818a8e598",
        "v": "0x1b"
      }
    },
    "publisher_merkle_root": "0x4e0a03960cea21f67d7f2b66c5457fa4fea3632a68d0f3bc01adb0588446efdf",
    "calculation_alg": {
      "version": "v1",
      "checksum": "9be7e9f9ed459417d96112a7467bd0b27575a2c7847195c68f805b70ce1795ba",
      "type": "median"
    }
  },
  "type": "PUT",
  "signed_implied_volatilities": [
    {
      "external_asset_id": "BTCUSD",
      "implied_volatility": "101344782928537490000000",
      "timestamped_signature": {
        "timestamp": 1734127259251174100,
        "msg_hash": "0x977891628f4fc326f858ec33ba03da335e2ec4648a9f9332ab0317a64165fa7c",
        "signature": {
          "r": "0xb193e9ff3e3c0346ca74e194b8eab13cc9d49b73a68167b7a021ec979cb3aef7",
          "s": "0x07a7176c245e24777755ae3037450862bb4dbc1e4ff49304cd82c3d818a8e598",
          "v": "0x1b"
        }
      },
      "public_key": "0x51aa9e9C781F85a2C0636A835EB80114c4553098"
    }
  ]
}

Get Underlying Future Price

Get signed underlying future price data for a specific option.

get

/options/underlying_future_price

Authorizations

Query parameters

symbolstringrequired

Asset symbol (e.g. BTCUSD)

expirystring · daterequired

Option expiry date in YYYY-MM-DD format

strikestringrequired

Strike price in USD

typestring · enumrequired

Option type (PUT or CALL)

Options: PUT, CALL

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://rest.jp.stork-oracle.network/v1/options/underlying_future_price?symbol=text&expiry=2025-02-22&strike=text&type=PUT' \
  --header 'Authorization: YOUR_API_KEY'

200

400

500

{
  "symbol": "BTCUSD",
  "expiry": "2024-12-31",
  "strike": "50000",
  "timestamp": 1,
  "type": "PUT",
  "signed_underlying_future_prices": [
    {
      "underlying_future_price": "101344782928537490000000",
      "timestamped_signature": {
        "timestamp": 1734127259251174100,
        "msg_hash": "0x977891628f4fc326f858ec33ba03da335e2ec4648a9f9332ab0317a64165fa7c",
        "signature": {
          "r": "0xb193e9ff3e3c0346ca74e194b8eab13cc9d49b73a68167b7a021ec979cb3aef7",
          "s": "0x07a7176c245e24777755ae3037450862bb4dbc1e4ff49304cd82c3d818a8e598",
          "v": "0x1b"
        }
      },
      "external_asset_id": "BTCUSD",
      "public_key": "0x51aa9e9C781F85a2C0636A835EB80114c4553098"
    }
  ]
}