Data Availability Layer API (DAL)

Pull-based oracle submission using Data Availability Layer API

The on-chain price data can be updated on-demand by a user through the pull-based oracle. Off-chain price data are updated at sub-second intervals. Users with valid API key can access and submit the latest price data on-chain. The price data can be either accessed through REST API or WebSocket API.

The DAL API requires the X-API-Key header. Please contact us to receive a valid API key.

Basic Return Types

Property

Type

Explanation

symbol

string

symbol name

value

string

price value

aggregateTime

string

timestamp value

proof

string

proof hexstring

feedHash

string

feed hash hexstring

decimals

string

decimals

Rest API

Testnet (REST): https://dal.baobab.orakl.network
Mainnet (REST): https://dal.cypress.orakl.network

GET `/symbols`

returns supported symbols

Example Request

curl --location --request GET 'https://dal.baobab.orakl.network/symbols' \
--header 'X-API-Key: $API_KEY' \
--header 'Content-Type: application/json'

Example Response

[
"WAVES-KRW",
"BTC-USDT",
"CHF-USD",
"DAI-USDT",
"JOY-USDT",
"PAXG-USDT",
"GBP-USD",
"WEMIX-USDT",
"ATOM-USDT",
"DOGE-USDT",
"KSP-KRW",
"LTC-USDT",
"TRX-USDT",
"EUR-USD",
"JPY-USD",
"MNR-KRW",
"USDC-USDT",
"XRP-KRW",
"BNB-USDT",
"ETH-KRW",
"ETH-USDT",
"MBX-KRW",
"PER-KLAY",
"BLAST-KRW",
"BTC-KRW",
"DOT-USDT",
"FTM-USDT",
"ZRO-KRW",
"USDT-KRW",
"XRP-USDT",
"AVAX-USDT",
"BORA-KRW",
"KRW-USD",
"SOL-USDT",
"UNI-USDT",
"PEPE-USDT",
"SHIB-USDT",
"SOL-KRW",
"ADA-USDT",
"AKT-KRW",
"KLAY-USDT",
"MATIC-USDT",
"ONDO-KRW"
]

GET `/latest-data-feeds/all`

returns latest submission parameters for all supported pairs

Example Request

curl --location --request GET 'https://dal.baobab.orakl.network/latest-data-feeds/all' \
--header 'X-API-Key: $API_KEY' \
--header 'Content-Type: application/json'

Example Response

[
    {
        "symbol": "BTC-USDT",
        "value": "6426575817343",
        "aggregateTime": "1721886857",
        "proof": "0x6cb90489dddc93c376425355cb497353695e53d91a7d61c3f1e122b1e5c0e2367dc95d36f40d5960784250008ed4a9f18d75b189f0d72eb9e2564e0a05ad374a1c",
        "feedHash": "0xa92bcb5bc51aa5535ed0cc3f522992dd9a6fb2e8dd6dcf484705d93eb3cd167a",
        "decimals": "8"
    },
    {
        "symbol": "ETH-USDT",
        "value": "318659264245",
        "aggregateTime": "1721886857",
        "proof": "0xd7c13dd825dd112de3ce52f704514d60c41f6d34bea3be13fc44a46394376ebd3947bdcb8d8dec9ae2959d1992b99220d4bf60988c7482b9ee98d3079199096b1b",
        "feedHash": "0x7020b52841bb268cbc78137a54d4bf1f5305eed1039fb5d003ba95b8ededc46c",
        "decimals": "8"
    }
    ...
]

GET `/latest-data-feeds/{symbol,symbol,...}`

returns the latest submission parameters for requested pairs

Example Request

curl --location --request GET 'https://dal.baobab.orakl.network/latest-data-feeds/all' \
--header 'X-API-Key: $API_KEY' \
--header 'Content-Type: application/json'

Example Response

[
    {
        "symbol": "BTC-USDT",
        "value": "6426575817343",
        "aggregateTime": "1721886857",
        "proof": "0x6cb90489dddc93c376425355cb497353695e53d91a7d61c3f1e122b1e5c0e2367dc95d36f40d5960784250008ed4a9f18d75b189f0d72eb9e2564e0a05ad374a1c",
        "feedHash": "0xa92bcb5bc51aa5535ed0cc3f522992dd9a6fb2e8dd6dcf484705d93eb3cd167a",
        "decimals": "8"
    },
    {
        "symbol": "ETH-USDT",
        "value": "318659264245",
        "aggregateTime": "1721886857",
        "proof": "0xd7c13dd825dd112de3ce52f704514d60c41f6d34bea3be13fc44a46394376ebd3947bdcb8d8dec9ae2959d1992b99220d4bf60988c7482b9ee98d3079199096b1b",
        "feedHash": "0x7020b52841bb268cbc78137a54d4bf1f5305eed1039fb5d003ba95b8ededc46c",
        "decimals": "8"
    }
    ...
]

GET `/latest-data-feeds/transpose/all`

returns latest submission paramters for all pairs in transpose format

Example Request

curl --location 'https://dal.baobab.orakl.network/latest-data-feeds/transpose/all' \
--header 'X-API-Key: $API_KEY'

Example Response

{
    "symbols": [
        "ADA-USDT",
        "BTC-USDT",
        ...
    ],
    "values": [
        "39386169",
        "6416315907599",
        ...
    ],
    "aggregateTimes": [
        "1721888065",
        "1721888065",
        ...
    ],
    "proofs": [
        "0xb2257cad024889288e0a047d8ab55e0553a9ccafbfbb3ada10392abc2c2bc24c0398189260c4141a3e39b1361445d3d394b2fe0b953b97eaabe9c081dff4c4441b",
        "0x0ad8a61c99bd5b911b37c98d5424c02f7c22afad5b18a434c9e4132a4542da9a2e499b26b75e6e256bc1d77301e5f9edeb62967c3180db2b7b3dbf2c0e8c0c6c1c",
        ...
    ],
    "feedHashes": [
        "0x5f741f7995dc7d3a3a89dd2daccc6c019033c69204605aabf2739c3aa5ec8a62",
        "0xa92bcb5bc51aa5535ed0cc3f522992dd9a6fb2e8dd6dcf484705d93eb3cd167a",
        ...
    ],
    "decimals": [
        "8",
        "8",
        ...
    ]
}

Get `/latest-data-feeds/transpose/{symbol, symbol..}`

returns latest submission paramters for certain pairs in transpose format

Example Request

curl --location 'https://dal.baobab.orakl.network/latest-data-feeds/transpose/ADA-USDT,BTC-USDT' \
--header 'X-API-Key: $API_KEY'

Example Response

{
    "symbols": [
        "ADA-USDT",
        "BTC-USDT"
    ],
    "values": [
        "39386169",
        "6416315907599"
    ],
    "aggregateTimes": [
        "1721888065",
        "1721888065"
    ],
    "proofs": [
        "0xb2257cad024889288e0a047d8ab55e0553a9ccafbfbb3ada10392abc2c2bc24c0398189260c4141a3e39b1361445d3d394b2fe0b953b97eaabe9c081dff4c4441b",
        "0x0ad8a61c99bd5b911b37c98d5424c02f7c22afad5b18a434c9e4132a4542da9a2e499b26b75e6e256bc1d77301e5f9edeb62967c3180db2b7b3dbf2c0e8c0c6c1c"
    ],
    "feedHashes": [
        "0x5f741f7995dc7d3a3a89dd2daccc6c019033c69204605aabf2739c3aa5ec8a62",
        "0xa92bcb5bc51aa5535ed0cc3f522992dd9a6fb2e8dd6dcf484705d93eb3cd167a"
    ],
    "decimals": [
        "8",
        "8"
    ]
}

WebSocket API

Testnet (WS): ws://dal.baobab.orakl.network/ws

Mainnet (WS): ws://dal.cypress.orakl.network/ws

Connect and Request `/ws`

subscribes and pushes price feeds

Example Request

# connect
websocat ws://dal.baobab.orakl.network/ws -H "X-API-Key: $API_KEY"
# subscribe
{
  "method": "SUBSCRIBE",
  "params": [
    "submission@BTC-USDT"
  ]
}

Example Response

{
        "symbol": "BTC-USDT",
        "value": "6426575817343",
        "aggregateTime": "1721886857",
        "proof": "0x6cb90489dddc93c376425355cb497353695e53d91a7d61c3f1e122b1e5c0e2367dc95d36f40d5960784250008ed4a9f18d75b189f0d72eb9e2564e0a05ad374a1c",
        "feedHash": "0xa92bcb5bc51aa5535ed0cc3f522992dd9a6fb2e8dd6dcf484705d93eb3cd167a",
        "decimals": "8"
}

On-chain Price Data Submission

The price data is submitted on-chain through SubmissionProxy contract. The contract address can be found at JSON configuration.

`submit` function

Submits in bulk without strict checks. It will silently skip invalid submissions and submit only valid submissions.

Signature

function submit(
    bytes32[] calldata _feedHashes,
    int256[] calldata _answers,
    uint256[] calldata _timestamps,
    bytes[] calldata _proofs
)

ABI

[
  {
    "type": "function",
    "name": "submit",
    "inputs": [
      {
        "name": "_feedHashes",
        "type": "bytes32[]",
        "internalType": "bytes32[]"
      },
      {
        "name": "_answers",
        "type": "int256[]",
        "internalType": "int256[]"
      },
      {
        "name": "_timestamps",
        "type": "uint256[]",
        "internalType": "uint256[]"
      },
      {
        "name": "_proofs",
        "type": "bytes[]",
        "internalType": "bytes[]"
      }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  }
]

`submitStrict` function

Submits in bulk with strict checks. If one of the submission entry fails, the whole tx will fail with error

signature

function submitStrict(
        bytes32[] calldata _feedHashes,
        int256[] calldata _answers,
        uint256[] calldata _timestamps,
        bytes[] calldata _proofs
    )

[
  {
    "type": "function",
    "name": "submitStrict",
    "inputs": [
      {
        "name": "_feedHashes",
        "type": "bytes32[]",
        "internalType": "bytes32[]"
      },
      { "name": "_answers", "type": "int256[]", "internalType": "int256[]" },
      {
        "name": "_timestamps",
        "type": "uint256[]",
        "internalType": "uint256[]"
      },
      { "name": "_proofs", "type": "bytes[]", "internalType": "bytes[]" }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  }
]

`submitSingle` function

Submits single entry with checks.

signature

function submitSingle(bytes32 _feedHash, int256 _answer, uint256 _timestamp, bytes calldata _proof)

[
  {
    "type": "function",
    "name": "submitSingle",
    "inputs": [
      { "name": "_feedHash", "type": "bytes32", "internalType": "bytes32" },
      { "name": "_answer", "type": "int256", "internalType": "int256" },
      { "name": "_timestamp", "type": "uint256", "internalType": "uint256" },
      { "name": "_proof", "type": "bytes", "internalType": "bytes" }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  }
]

`submitWithoutSupersedValidation` function

Submit a batch of answers to multiple feeds. The answers are ignored if they have been superseded. If any of the answers do not meet the rest of required conditions the whole batch is reverted.

signature

    function submitWithoutSupersedValidation(
        bytes32[] calldata _feedHashes,
        int256[] calldata _answers,
        uint256[] calldata _timestamps,
        bytes[] calldata _proofs
    )

[
  {
    "type": "function",
    "name": "submitWithoutSupersedValidation",
    "inputs": [
      {
        "name": "_feedHashes",
        "type": "bytes32[]",
        "internalType": "bytes32[]"
      },
      { "name": "_answers", "type": "int256[]", "internalType": "int256[]" },
      {
        "name": "_timestamps",
        "type": "uint256[]",
        "internalType": "uint256[]"
      },
      { "name": "_proofs", "type": "bytes[]", "internalType": "bytes[]" }
    ],
    "outputs": [],
    "stateMutability": "nonpayable"
  }
]

`submitSingleWithoutSupersedValidation` function

Submit a single submission to a feed. The submission is ignored if it has been superseded. If the submission does not meet the rest of required conditions the submission is reverted.

signature

function submitSingleWithoutSupersedValidation(bytes32 _feedHash, int256 _answer, uint256 _timestamp, bytes calldata _proof)

{
  "type": "function",
  "name": "submitSingleWithoutSupersedValidation",
  "inputs": [
    { "name": "_feedHash", "type": "bytes32", "internalType": "bytes32" },
    { "name": "_answer", "type": "int256", "internalType": "int256" },
    { "name": "_timestamp", "type": "uint256", "internalType": "uint256" },
    { "name": "_proof", "type": "bytes", "internalType": "bytes" }
  ],
  "outputs": [],
  "stateMutability": "nonpayable"
}

PreviousL2 Services NextExample Projects

Last updated 1 month ago

Basic Return Types

Rest API

GET /symbols

GET /latest-data-feeds/all

GET /latest-data-feeds/{symbol,symbol,...}

GET /latest-data-feeds/transpose/all

Get /latest-data-feeds/transpose/{symbol, symbol..}

WebSocket API

Connect and Request /ws

On-chain Price Data Submission

submit function

Signature

ABI

submitStrict function

submitSingle function

submitWithoutSupersedValidation function

submitSingleWithoutSupersedValidation function

GET `/symbols`

GET `/latest-data-feeds/all`

GET `/latest-data-feeds/{symbol,symbol,...}`

GET `/latest-data-feeds/transpose/all`

Get `/latest-data-feeds/transpose/{symbol, symbol..}`

Connect and Request `/ws`

`submit` function

`submitStrict` function

`submitSingle` function

`submitWithoutSupersedValidation` function

`submitSingleWithoutSupersedValidation` function