Discord presence, activities and other integrations RESTful API, ready for use in under 10 seconds.

Introduction

Our Presence API is a RESTful API that allows you to access to your live Discord presence via an API endpoint: (api.harmy.gg/user/:user_ID) - example: you can use it for displaying your online status (online, idle, dnd, offline) or what you are listening to on Spotify on your own website.

There is a GitHub connection option which you can enable using our Discord bot for displaying your account information, such as public repositories, URL, bio and more.

We also give you the possibility to store your own K/V (key/value), which you can create and manage through our Discord bot.

Get started with 1 click

Join our Discord server and you are good to go and able to request your Discord user data. Simple is that.

Table of Contents

• API Docs
  • K/V
    • What is a K/V system?
    • Create a K/V pair
    • Access through the API
    • Limitations
• Authorization
  • Get the API Token
  • Hashed Tokens
• Error Codes
• Spotlight

API Docs

Get a user’s Discord presence data.

GET - https://api.harmy.gg/user/:user_ID

Example response:

{
    "presence": {
        "userId": "470320681905684500",
        "status": "dnd",
        "global_name": "Vaq",
        "server_name": null, //Your nick in our Discord server
        "avatar": "5c11d7292c91e510c2b4f07946ea6d72",
        "spotifyActivity": {
            "name": "Spotify",
            "type": 2,
            "song": "BMW",
            "artist": "Pashanim",
            "applicationId": null,
            "timestamps": {
                "start": 1720814201608,
                "end": 1720814322741
            },
            "party": {
                "id": "spotify:470320681905684500"
            },
            "syncId": "56MDdzieU2dTT3YLpCdpcA",
            "assets": {
                "largeText": "Himmel über Berlin",
                "largeImage": "ab67616d0000b273fa2f0c9e719ca71f2686ddf3"
            },
            "flags": 48,
            "createdTimestamp": 1720814203334
        }
    },
    "KV": {
        "First1": "Key/ValuePair0"
    },
    "github": {
        "id": 111227553,
        "username": "vaqqq",
        "avatar_url": "https://avatars.githubusercontent.com/u/111227553?v=4",
        "url": "https://github.com/vaqqq",
        "company": null,
        "blog": "https://harmy.gg",
        "bio": "casual coder",
        "public_repos": 1
    }
}

K/V

What is a K/V system?

The Key/Value system allows users to store and retriev their own data associated with their user profiles. Example: You could use it for storing user preferences, settings, or any other custom data relevant to the user's profile, like the user's location or email.

Create a key/value pair

The only thing you have to do is to run the .add <key> <value> command of our Discord bot for creating a new key/value pair.

Access through the API

Use your API token as an authentification method to access your custom data.

Limitations

Property	Max. Characters	Data Type
Key	165	String
Value	10'000	String

Authorization

Get the API token

Run the .token command in our Discord server. You will receive a DM from our Discord bot, including the API Token.

Note: If you think that your token has been compromised, you can simply just re-run the command for resetting your API token.

Hashed Tokens

Your API token will be hashed using a secure hashing algorithm. This means even in the unlikely event of a data breach, your tokens cannot be easily read or misused. - Your data is safe.

Error Codes

Code	Name	Description
200	OK	HTTP request was successfully handled
400	Bad Request	Cannot or will not process the request due to an apparent client error
401	Unauthorized	Authentication is required and has failed or has not yet been provided
404	Not Found	The requested resource could not be found but may be available in the future
429	Rate Limit	120 requests/min, 3 requests/s
500	Internal Server Error	Given when an unexpected condition was encountered
504	Gateway Timeout	Currently caused by the automatic switching of the system to sleep mode after a specific time (fixed soon)

Spotlight ⭐

Here are a few websites that use harmy:

• harmonybot.ch

Created with ❤️