Menu

API (v1)

There is one main object in our API: Leaderboard. We currently only offer a JSON response format. If you have any problems or requests please contact us.


Leaderboard

Retrieve your team leaderboard (Sign in to HeyTaco! to display your team id below):

https://www.heytaco.chat/api/v1/json/leaderboard/{%teamId%}?days=1

Example JSON Response

{
    "leaderboard": [{
        "received_by_id": "U123456789",
        "username": "test",
        "team_name": "Test",
        "avatar": "https://secure.gravatar.com/avatar/9828a53f505ab5ea9c7daedee91.png",
        "timestamp": "2016-11-12T10:30:32.000Z",
        "count": "1"
    }]
}

Options

Property Values
days 1,2,3+ (any number of days)

Errors

response meaning
invalid_team Team does not exist

Please note that our Leaderboard API has a 5 minute cache.