HomeDocumentationAPI Reference
Log In
API Reference

Get Maker Program Scores

Method Name

public/get_maker_program_scores

Get scores breakdown by maker program.

Parameters

epoch_start_timestamp  integer required
Start timestamp of the program epoch
program_name  string required
Program name

Response

id  string or integer required
result  object required
result. total_score  string required
Total score across all market makers for the epoch
result. total_volume  string required
Total volume across all market makers for the epoch
result. program  object required
Program details
result.program. end_timestamp  integer required
End timestamp of the epoch
result.program. min_notional  string required
Minimum dollar notional to quote for eligibility
result.program. name  string required
Name of the program
result.program. start_timestamp  integer required
Start timestamp of the epoch
result.program. asset_types  array of strings required
List of asset types covered by the program
result.program. currencies  array of strings required
List of currencies covered by the program
result.program. rewards  object required
Rewards for the program as a token -> total reward amount mapping
result. scores  array of objects required
Scores breakdown of the program by market maker
result.scores[]. coverage_score  string required
Coverag component of the score of the account for this program
result.scores[]. holder_boost  string required
A custom account multiplier for the score due to holding tokens
result.scores[]. quality_score  string required
Quality component of the score of the account for this program
result.scores[]. total_score  string required
Total score of the account for this program
result.scores[]. volume  string required
Volume traded by the account for this epoch
result.scores[]. volume_multiplier  string required
Multiplier for the volume traded by the account
result.scores[]. wallet  string required
Wallet address of the account

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}