> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dis.dog/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Look up Discord accounts from your own code: same account, same key, same quota and the same modules as your searches on dis.dog.

The DisDog API gives your scripts, bots and tools the same search as the box on [dis.dog](https://dis.dog): give it a Discord ID, a username or an invite link, and it tells you what it is and runs every lookup module on it.

It runs on your DisDog account. There is no separate API key: the **access key you log in with is your API key**, and a search through the API takes one search from the same daily quota as a search on the website.

> [!NOTE]
>
> The API comes with the **Hound** and **Alpha** plans. A Pup (free) key can call [`/v1/me`](https://docs.dis.dog/api-reference/endpoints/me) and [`/v1/modules`](https://docs.dis.dog/api-reference/endpoints/modules) only; every other route answers `403 plan_has_no_api`. [Compare plans](https://dis.dog/pricing).

## Start here

> [card] [Quickstart](https://docs.dis.dog/quickstart.md)
>
> Get a key and run your first search in two minutes.

> [card] [Authentication](https://docs.dis.dog/authentication.md)
>
> Send your key, and replace it if it leaks.

> [card] [Limits & quotas](https://docs.dis.dog/limits.md)
>
> Daily quota, the Pup rate limit, and the headers that report them.

> [card] [API reference](https://docs.dis.dog/api-reference/introduction.md)
>
> Every route, with a playground to try it.

## What you can search

One route, `GET /v1/search`, takes whatever you have, recognises it and runs every module at once. Each module also has its own route (`/v1/profile/{id}`, `/v1/roblox/{id}`…) when you only need one answer. [Every route →](https://docs.dis.dog/api-reference/introduction.md)

| You give it | Example | Recognised as |
| - | - | - |
| A Discord ID (17 to 20 digits) | `80351110224678912` | `discord_id` |
| A username, new or legacy | `disdog`, `@DisDog`, `name#1234` | `username` |
| An invite link | `discord.gg/disdog`, `https://discord.com/invite/disdog` | `invite` |

For a Discord ID, the answer already carries the account’s **exact creation date**: it is encoded in the ID itself. [How a search works →](https://docs.dis.dog/api-reference/endpoints/search.md)

## Modules

Every search runs every lookup module. Each answers one question about the account.

| Module | Id | What it answers |
| - | - | - |
| [Discord profile](https://docs.dis.dog/modules/profile.md) | `profile` | Who the account is: names, avatar, banner, badges, past names |
| [Connected accounts](https://docs.dis.dog/modules/connections.md) | `connections` | Bio, pronouns, theme, linked accounts (Steam, Spotify, X…) |
| [Server memberships](https://docs.dis.dog/modules/servers.md) | `servers` | Which servers the account is in |
| [Message logs](https://docs.dis.dog/modules/messages.md) | `messages` | What the account said in indexed servers |
| [Discord → Roblox](https://docs.dis.dog/modules/roblox.md) | `roblox` | The Roblox account linked to it |
| [Discord → guns.lol](https://docs.dis.dog/modules/gunslol.md) | `gunslol` | The guns.lol pages that show it |
| [FiveM database](https://docs.dis.dog/modules/fivem.md) | `fivem` | Its FiveM player records |

> [!NOTE]
>
> Every module above answers today except FiveM, whose data source is still being connected: for now its entry answers `"status": "no_data"`. [`GET /v1/modules`](https://docs.dis.dog/api-reference/endpoints/modules) lists the modules.

## Conventions

* **Base URL:** `https://api.dis.dog/v1`, over HTTPS only.
* **Format:** responses are JSON in UTF-8.
* **Times** are ISO 8601, in UTC.
* **Errors** are JSON too, with a stable code: `{ "error": "invalid_query" }`. [Every error →](https://docs.dis.dog/errors.md)
* **Versioning:** the version is in the path (`/v1`). Build your code to ignore fields it does not know: new ones can appear, especially as modules go live.

> [!WARNING]
>
> DisDog returns data about real people. Use it only for lawful purposes you can justify, and never to stalk, harass or expose anyone — see the [Terms and Acceptable use](https://dis.dog/terms). Anyone can [remove their Discord ID](https://docs.dis.dog/data-removal.md) from DisDog.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.