The Synth API provides the latest & historical prediction rates as well as the current leaderboard.
It selects the top 'limit' miners from the the meta-leaderboard to calculate the probability of liquidation in 6, 12, 18 and 24 hours for different price levels.
| asset | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
{- "current_price": 0,
- "data": [
- {
- "long_liquidation_probability": {
- "6": 0,
- "12": 0,
- "18": 0,
- "24": 0
}, - "price_change": "string",
- "short_liquidation_probability": {
- "6": 0,
- "12": 0,
- "18": 0,
- "24": 0
}
}
]
}It selects the top 'limit' miners from the the meta-leaderboard to calculate price intervals and probability to stay in each interval for the next 24 hours, expected time to stay in each interval and impermanent loss.
| asset | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
{- "current_price": 0,
- "data": [
- {
- "expected_impermanent_loss": 0,
- "expected_time_in_interval": 0,
- "interval": {
- "full_width": "string",
- "lower_bound": 0,
- "upper_bound": 0
}, - "probability_to_stay_in_interval": {
- "24": 0
}
}
]
}Calculate the probability of asset price to be above 11 prices and bellow 11 prices.
| asset | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
{- "current_price": 0,
- "data": {
- "24h": {
- "probability_above": {
- "property1": 0,
- "property2": 0
}, - "probability_below": {
- "property1": 0,
- "property2": 0
}
}
}
}It selects the top 'limit' miners from the the meta-leaderboard to calculate the call and put prices for different strike prices.
| asset | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
{- "call_options": {
- "property1": 0,
- "property2": 0
}, - "current_price": 0,
- "expiry_time": "string",
- "put_options": {
- "property1": 0,
- "property2": 0
}
}It selects the top 'limit' miners from the the meta-leaderboard to compare polymarket and synth probability and outcome for each range.
| asset | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
[- {
- "best_ask_price": 0,
- "best_ask_size": 0,
- "best_bid_price": 0,
- "best_bid_size": 0,
- "cmp_type": "string",
- "current_outcome": 0,
- "current_price": 0,
- "current_time": "string",
- "event_creation_time": "string",
- "event_end_time": "string",
- "event_start_time": "string",
- "polymarket_last_trade_outcome": 0,
- "polymarket_last_trade_price": 0,
- "polymarket_last_trade_time": "string",
- "polymarket_outcome": 0,
- "polymarket_probability": 0,
- "ref_prices": [
- 0
], - "slug": "string",
- "synth_outcome": 0,
- "synth_probability": 0,
- "title": "string"
}
]It selects the top 'limit' miners from the the meta-leaderboard to compare polymarket and synth probability and outcome.
| asset | string Example: asset=BTC Asset: ETH or BTC |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
{- "best_ask_price": 0,
- "best_ask_size": 0,
- "best_bid_price": 0,
- "best_bid_size": 0,
- "current_outcome": "string",
- "current_price": 0,
- "current_time": "string",
- "event_creation_time": "string",
- "event_end_time": "string",
- "event_start_time": "string",
- "polymarket_last_trade_outcome": "string",
- "polymarket_last_trade_price": 0,
- "polymarket_last_trade_time": "string",
- "polymarket_outcome": "string",
- "polymarket_probability_up": 0,
- "slug": "string",
- "start_price": 0,
- "synth_outcome": "string",
- "synth_probability_up": 0
}It selects the top 'limit' miners from the the meta-leaderboard to compare polymarket and synth probability and outcome.
| asset | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
{- "best_ask_price": 0,
- "best_ask_size": 0,
- "best_bid_price": 0,
- "best_bid_size": 0,
- "current_outcome": "string",
- "current_price": 0,
- "current_time": "string",
- "event_creation_time": "string",
- "event_end_time": "string",
- "event_start_time": "string",
- "polymarket_last_trade_outcome": "string",
- "polymarket_last_trade_price": 0,
- "polymarket_last_trade_time": "string",
- "polymarket_outcome": "string",
- "polymarket_probability_up": 0,
- "slug": "string",
- "start_price": 0,
- "synth_outcome": "string",
- "synth_probability_up": 0
}It selects the top 'limit' miners from the the meta-leaderboard to calculate the volatility.
| asset | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
{- "current_price": 0,
- "forecast_future": {
- "average_volatility": 0,
- "volatility": [
- 0
]
}, - "forecast_past": {
- "average_volatility": 0,
- "volatility": [
- 0
]
}, - "realized": {
- "average_volatility": 0,
- "prices": [
- {
- "price": 0,
- "returns": 0
}
], - "volatility": [
- 0
]
}
}Get price distribution percentiles over the forecast horizon.
| asset | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14). See 'Leaderboard - Latest Meta-Leaderboard'. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
{- "current_price": 0,
- "forecast_future": {
- "percentiles": [
- {
- "0.2": 0,
- "0.5": 0,
- "0.05": 0,
- "0.005": 0,
- "0.8": 0,
- "0.35": 0,
- "0.65": 0,
- "0.95": 0,
- "0.995": 0
}
]
}
}Gets the leaderboard history.
| start_time required | string Example: start_time=2025-02-03T10:19:04Z an URL encoded ISO 8601 date/time to start from (2025-02-03T10:19:04Z or 2025-02-03T17:19:04+07:00 or 2025-02-03) |
| end_time required | string Example: end_time=2025-02-03T10:19:04Z an URL encoded ISO 8601 date/time to end at (2025-02-03T10:19:04Z or 2025-02-03T17:19:04+07:00 or 2025-02-03) |
| prompt_name | string Example: prompt_name=low Prompt name, high for 1h prompt or low for 24h prompt |
[- {
- "coldkey": "string",
- "ip_address": "string",
- "neuron_uid": 0,
- "rewards": 0,
- "updated_at": "string"
}
]Gets the current leaderboard.
| prompt_name | string Example: prompt_name=low Prompt name, high for 1h prompt or low for 24h prompt |
[- {
- "coldkey": "string",
- "ip_address": "string",
- "neuron_uid": 0,
- "rewards": 0,
- "updated_at": "string"
}
]Gets the meta-leaderboard history, which aggregates miners' incentives over a period of days in the past.
| start_time required | string Example: start_time=2025-02-03T10:19:04Z an URL encoded ISO 8601 date/time to start from (2025-02-03T10:19:04Z or 2025-02-03T17:19:04+07:00 or 2025-02-03) |
| prompt_name | string Example: prompt_name=low Prompt name, high for 1h prompt or low for 24h prompt |
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14) |
[- {
- "coldkey": "string",
- "ip_address": "string",
- "neuron_uid": 0,
- "rewards": 0,
- "updated_at": "string"
}
]Get the current meta-leaderboard, which aggregates miners' incentives over a period of days. This provides another way to rank prediction accuracy, thereby increasing stability.
| days | integer Example: days=14 Number of days to aggregate for the meta-leaderboard (default is 14) |
| prompt_name | string Example: prompt_name=low Prompt name, high for 1h prompt or low for 24h prompt |
[- {
- "coldkey": "string",
- "ip_address": "string",
- "neuron_uid": 0,
- "rewards": 0,
- "updated_at": "string"
}
]Gets the latest prediction rates of the current best miner.
| asset required | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| time_increment required | integer Example: time_increment=300 the time interval (in seconds) of the validator prompt between each rate. 300 or 60. |
| time_length required | integer Example: time_length=86400 the length of time (in seconds) of the validator prompt from the start time. 86400 or 3600. |
| Authorization required | string Example: Apikey MY_API_KEY API key |
[- {
- "miner_uid": 0,
- "predictions": [
- [
- 0
]
], - "start_time": 0
}
]Gets the historical prediction rates.
| miner required | Array of integers a list of specific miners by their ID |
| asset required | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| start_time required | string Example: start_time=2025-02-03T10:19:04Z an ISO 8601 date/time to start the historical rates from (2025-02-03T10:19:04Z or 2025-02-03T17:19:04+07:00 or 2025-02-03) |
| time_increment required | integer Example: time_increment=300 the time interval (in seconds) of the validator prompt between each rate. 300 or 60. |
| time_length required | integer Example: time_length=86400 the length of time (in seconds) of the validator prompt from the start time. 86400 or 3600. |
| Authorization required | string Example: Apikey MY_API_KEY API key |
[- {
- "miner_uid": 0,
- "predictions": [
- [
- 0
]
], - "start_time": 0
}
]Gets the latest valid prediction rates.
| miner required | Array of integers a list of specific miners by their ID |
| asset required | string Example: asset=BTC the symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX |
| time_increment required | integer Example: time_increment=300 the time interval (in seconds) of the validator prompt between each rate. 300 or 60. |
| time_length required | integer Example: time_length=86400 the length of time (in seconds) of the validator prompt from the start time. 86400 or 3600. |
| limit | integer Example: limit=10 Number of miners from the meta-leaderboard to use for the analysis (default is 10) |
| Authorization required | string Example: Apikey MY_API_KEY API key |
[- {
- "miner_uid": 0,
- "predictions": [
- [
- 0
]
], - "start_time": 0
}
]Gets the validation scores for all miners between two dates
| from required | string Example: from=2025-02-03T10:19:04Z Start date (2025-02-03T10:19:04Z or 2025-02-03T17:19:04+07:00 or 2025-02-03) |
| to required | string Example: to=2025-02-03T10:19:04Z End date (2025-02-03T10:19:04Z or 2025-02-03T17:19:04+07:00 or 2025-02-03) |
| miner_uid | integer Optional miner ID to filter by |
| asset | string Example: asset=BTC The symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX (default BTC) |
| time_increment | integer Example: time_increment=300 the time interval (in seconds) of the validator prompt between each rate: 300 or 60 (default 300). |
| time_length | integer Example: time_length=86400 the length of time (in seconds) of the validator prompt from the start time: 86400 or 3600 (default 86400) |
[- {
- "asset": "string",
- "crps": 0,
- "miner_uid": 0,
- "prompt_score": 0,
- "scored_time": "string",
- "time_length": 0
}
]Gets the most recent validation scores for all miners
| asset | string Example: asset=BTC The symbol of the asset: BTC, ETH, XAU, SOL, SPYX, NVDAX, TSLAX, AAPLX, GOOGLX (default BTC) |
| time_increment | integer Example: time_increment=300 the time interval (in seconds) of the validator prompt between each rate: 300 or 60 (default 300). |
| time_length | integer Example: time_length=86400 the length of time (in seconds) of the validator prompt from the start time: 86400 or 3600 (default 86400) |
[- {
- "asset": "string",
- "crps": 0,
- "miner_uid": 0,
- "prompt_score": 0,
- "scored_time": "string",
- "time_length": 0
}
]