ETHRank API Documentation
Get ETHRank and Score for a Single Address
Returns the ETHRank and score of a given address in JSON format.
https://ethrank.io/api/address/[address]
Try this endpoint in your browser 🔗.
Sample Response
{"score":610,"rank":1151,"progress":["040","111","146","240","041","042","04","001"]}
How to use this API
score | The cumulative score calculated by the sum of all steps, goals and acheivements completed. |
rank | The current rank of the user for this season (1=top score) |
progress | A string array mapping to the indexes of the steps, goals and achievements in the JSON definition for the current season. Example: 000 0 - First Achievement in the list 0 - First Goal in the First Achievement 0 - First Step in the Second Goal of the First Achievement Using the Season 2 JSON definitions as an example, this user has completed the "Own 1 Metagon" Step of the "ETHRank Supporter" Goal which is part of the "The Enthusiast" Achievement. |
Get Labels for a Single Address
Returns labels for spanning all seasons of a given address in JSON format.
https://ethrank.io/api/labels/[address]
Try this endpoint in your browser 🔗.
Sample Response
[{ "name": "ETHRank Elite", "slug": "ethrank-elite", "category": "reputation", "points": 50, "steps": [ { "name": "Own 1 ETHRank Season 1 Badge", "points": 50, "type": "own_token_by_address", "params": { "count": 1, "address": "0x26AdbB495C1A66238e4155E407E0702FFeC03dF2" } } ]}]
How to use this API
name | The name of the achievement, goal, or step |
slug | A search-engine-friendly version of the name |
category | The corresponding ETHRank category for this achievement |
points | The number of points awarded for this achievement |
steps | The steps involved in reaching the achievement |
Usage Limits
Please be considerate in your use of the ETHRank API. Do not exceed 1 request per 5 seconds, or 10 requests per minute. Attempts to go beyond these limits are restricted.
Copyright Notice
Use of this API must be accompanied by a link back to ETHRank.io, or the text "Powered by ETHRank" must be clearly visible on any websites, dapps, projects, businesses, reports, or any other work product that uses this API.
Disclaimer
This API is provided free of charge, and is subject to change and/or cancellation at any time. ETHRank API is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.