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_timestampintegerrequired
Start timestamp of the program epoch
program_namestringrequired
Program name

Response

idstring or integerrequired
resultobjectrequired
result.total_scorestringrequired
Total score across all market makers for the epoch
result.total_volumestringrequired
Total volume across all market makers for the epoch
result.programobjectrequired
Program details
result.program.end_timestampintegerrequired
End timestamp of the epoch
result.program.min_notionalstringrequired
Minimum dollar notional to quote for eligibility
result.program.namestringrequired
Name of the program
result.program.start_timestampintegerrequired
Start timestamp of the epoch
result.program.asset_typesarray of stringsrequired
List of asset types covered by the program
result.program.currenciesarray of stringsrequired
List of currencies covered by the program
result.program.rewardsobjectrequired
Rewards for the program as a token -> total reward amount mapping
result.scoresarray of objectsrequired
Scores breakdown of the program by market maker
result.scores[].coverage_scorestringrequired
Coverag component of the score of the account for this program
result.scores[].holder_booststringrequired
A custom account multiplier for the score due to holding tokens
result.scores[].quality_scorestringrequired
Quality component of the score of the account for this program
result.scores[].total_scorestringrequired
Total score of the account for this program
result.scores[].volumestringrequired
Volume traded by the account for this epoch
result.scores[].volume_multiplierstringrequired
Multiplier for the volume traded by the account
result.scores[].walletstringrequired
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}