> ## 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.

# Get your account

> Your plan, when it ends, and what is left of today's quota. Never spends a search.

Use it to check a key, or to read your quota before a batch of searches. It never spends a search.

On Alpha, `usage.limit` and `usage.remaining` are `null` (no daily limit), and the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers say `unlimited`. `planExpiresAt` is `null` on Pup. [Plans and limits →](https://docs.dis.dog/limits.md)


## OpenAPI

````yaml GET /v1/me
openapi: 3.1.0
info:
  title: dis.dog API
  version: 1.0.0
  description: >-
    Discord OSINT from one key. Look up a Discord ID, a username or an invite
    and get the profile, the servers it has been seen in, its message logs, and
    the linked Roblox and guns.lol accounts. Your access key authenticates both
    the website and this API.


    **Base URL** `https://api.dis.dog`  

    **Auth** send your key as `Authorization: Bearer DD-...` (or `X-API-Key:
    DD-...`).  

    The API is included with the **Hound** and **Alpha** plans. On the free plan
    only `/v1/me` and `/v1/modules` answer; every other endpoint returns `403
    plan_has_no_api`.
servers:
  - url: https://api.dis.dog
security:
  - bearerAuth: []
paths:
  /v1/me:
    get:
      tags:
        - Account
      summary: Your key and quota
      description: >-
        Your plan and today's usage. Works on every plan, including free. Does
        not count against the quota.
      responses:
        '200':
          description: Account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        '401':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Me:
      type: object
      properties:
        plan:
          type: string
          enum:
            - free
            - hound
            - alpha
          example: hound
        planExpiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When a paid plan ends; null on free.
        usage:
          type: object
          properties:
            used:
              type: integer
              example: 12
            limit:
              type:
                - integer
                - 'null'
              description: null on Alpha (unlimited).
              example: 500
            remaining:
              type:
                - integer
                - 'null'
              example: 488
            resetAt:
              type: string
              format: date-time
              description: Next 00:00 UTC.
    Error:
      type: object
      required:
        - error
      description: >-
        Every error is a flat object with an `error` code. Some add fields (for
        example `retryAfterMs` on `rate_limited`).
      properties:
        error:
          type: string
          example: plan_has_no_api
          enum:
            - invalid_request
            - invalid_id
            - invalid_name
            - invalid_invite
            - unauthorized
            - invalid_api_key
            - plan_has_no_api
            - user_not_found
            - invite_not_found
            - not_available
            - removed_by_owner
            - rate_limited
            - quota_exceeded
            - module_unavailable
            - upstream_unavailable
            - upstream_busy
            - not_found
        retryAfterMs:
          type: integer
          description: 'On `rate_limited`: wait this long before retrying.'
          example: 2000
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your access key, `DD-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX`. The same key is
        your website login. Keep it server-side.

````

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