Rest API Documentation



Overview

List of Tokens

Latest

Historical

All Risk Scores

Returns the time series of the Suprafin risk scores for all the tokens for which SupraFin has a score, between two dates.


In general, to use the API call on your browser:
* If there are no query parameters, append ?api_key=YourApiKey at the end of your request URL
* If there are query parameters, append &api_key=YourApiKey at the end of your request URL.
Make sure you replace YourApiKey with your API key.


Query Parameters
Response Format
startDate
string
Required

Returns scores at or after this date. Format is iso8601
Example: startDate=2022-10-28

endDate
string
Required

Returns scores up to and including this date. Format is iso8601
Example: endDate=2022-10-28

response
int

Indicates whether the call succeeded (200) or generated an error (error code)

message
string

Provides details on the error if applicable

data
array

Array of risk score objects for the tokens specified in the query parameters between two dates.
The risk score objects have this structure:

symbolstring
The symbol of the token
typestring
The type of the token: exchange, stablecoin, utility, etc.
histscoresarray
Array of objects that associate a Date with a Scores object.
datestring
Date of the score. Format: iso8601.
Example: 2022-10-31
scoresobject
A risk scores object. The score object has this structure:
totalnumber
Total score of the token
adoptionobject
Score of the token in the Adoption category
assetsobject
Score of the token in the Assets category
marketobject
Score of the token in the Market category
sustainabilityobject
Score of the token in the Sustainability category
technologyobject
Score of the token in the Technology category

Response