Rest API Documentation



Overview

List of Tokens

Latest

Historical

Risk Score By Token

Returns the latest values of the Suprafin risk scores for the specified tokens.


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
symbols
string
Required

Comma separated list of symbols of interest
Example: symbols=BTC,USDC,ETH

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 symbols specified in the query parameters. Some risk categories and sub-categories only apply to certain token types. Only the categories and subcategories relevant to the token will be displayed. Click this link: Risk Scores Object for a full description of the return fields (risk categories and subcategories). The risk score object has this structure:

symbolstring
The symbol of the token
typestring
The type of the token: exchange, stablecoin, utility, defi, etc.
datestring
Date the risk score was last updated. 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