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. [e-mail] 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.

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /v1/prices/assets HTTP/1.1
Host: rest.jp.stork-oracle.network
Accept: */*

{
  "data": [
    "BTCUSD"
  ]
}

Get Latest Prices

get

Get latest real-time prices for specified assets.

Authorizations

Query parameters

assetsstringRequired

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

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /v1/prices/latest HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*

{
  "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": {
          "signature": {
            "r": "0xb193e9ff3e3c0346ca74e194b8eab13cc9d49b73a68167b7a021ec979cb3aef7",
            "s": "0x07a7176c245e24777755ae3037450862bb4dbc1e4ff49304cd82c3d818a8e598",
            "v": "0x1b"
          },
          "timestamp": 1734127259251174100,
          "msg_hash": "0x977891628f4fc326f858ec33ba03da335e2ec4648a9f9332ab0317a64165fa7c"
        },
        "publisher_merkle_root": "0x4e0a03960cea21f67d7f2b66c5457fa4fea3632a68d0f3bc01adb0588446efdf",
        "calculation_alg": {
          "type": "median",
          "version": "v1",
          "checksum": "9be7e9f9ed459417d96112a7467bd0b27575a2c7847195c68f805b70ce1795ba"
        }
      },
      "signed_prices": [
        {
          "publisher_key": "0x51aa9e9C781F85a2C0636A835EB80114c4553098",
          "external_asset_id": "BTCUSD",
          "signature_type": "evm",
          "price": "101344782928537490000000",
          "timestamped_signature": {
            "signature": {
              "r": "0xb193e9ff3e3c0346ca74e194b8eab13cc9d49b73a68167b7a021ec979cb3aef7",
              "s": "0x07a7176c245e24777755ae3037450862bb4dbc1e4ff49304cd82c3d818a8e598",
              "v": "0x1b"
            },
            "timestamp": 1734127259251174100,
            "msg_hash": "0x977891628f4fc326f858ec33ba03da335e2ec4648a9f9332ab0317a64165fa7c"
          },
          "metadata": null
        }
      ]
    }
  ]
}

Get Historical Price Metrics

get

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

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.

Available options:

symbolstringRequired

A unique identifier for an asset.

Example: BTCUSD

Responses

get

HTTPcURLJavaScriptPython

GET /v1/tradingview/history HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*

200

successful operation

No content

List EVM chain Deployments

get

Get the list of EVM chain deployments and their details.

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

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

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

Get Implied Volatility

get

Get signed implied volatility data for a specific option.

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)

Available options:

Responses

application/json

objectOptional

Aggregated implied volatility data with signatures

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /v1/options/implied_volatility HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*

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

Get Underlying Future Price

get

Get signed underlying future price data for a specific option.

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)

Available options:

Responses

application/json

objectOptional

Response containing signed underlying future price data

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /v1/options/underlying_future_price HTTP/1.1
Host: rest.jp.stork-oracle.network
Authorization: YOUR_API_KEY
Accept: */*

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