/dataSpecs

Data specifications for request ID's

Tellor Data Specifications

This repository contains specifications of data requested from, reported to, and retrieved from Tellor oracles. Each specification is called a Query.

For Tellor Users:

Price data:

First check if the price data is already being reported here.

Need a spot price from Tellor? Generate a unique identifier, or query ID, for the asset/currency pair using this tool. After, use that ID to pay reporters to put that data on-chain. Then retrieve the reported spot price from from the oracle like this.

Custom data:

First, check in /types if there's already a query type that defines the data you need.

If not, create a new query type, pay reporters to put that data on-chain, and retrieve that data from a Tellor oracle like this.

For Tellor Reporters:

To find out what data to report, there's two options:

  • Use our reporter client to automatically report the expected response of queries that Tellor users are funding.
  • Check for newly funded queries, then refer to that query's expected response in /types for the required data to report. Be sure to read the dispute considerations section for that query.

Create New Query Type

To create a new Query, or specification, for custom data you need from Tellor oracles, there's two options:

  • Make an issue like this and the Tellor team will help with the next steps.
  • Fork this repository and make a pull request for a new Query type in ./types using this template.

Contribute

Join our discord, help us with issues here on Github, or feel free to reach out anytime info@tellor.io.

Maintainers

This repository is maintained by the Tellor team.

Copyright

Tellor Inc. 2022