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

# Get current API key

> Retrieve details about the API key used to authenticate the request: its scopes, package restriction, organization ID, and current rate-limit quota. Useful as a first call to verify a key works, and to check remaining rate-limit quota. This endpoint requires no scope — any active key can call it. The key secret is never returned.



## OpenAPI

````yaml api/openapi.json GET /v1/api-keys/me
openapi: 3.1.0
info:
  title: SOAX API
  version: v1
  description: >-
    Programmatic access to your SOAX account: manage proxy packages, generate
    connection strings, browse available locations, pull usage analytics, and
    manage API keys. All endpoints are served over HTTPS and return JSON.
servers:
  - url: https://api.platform.soax.com
security:
  - bearerAuth: []
tags:
  - name: API Keys
    description: >-
      Self-service management of the API keys used to authenticate with this
      API.
  - name: Packages
    description: >-
      Read proxy packages, build proxy connection strings, and rotate package
      passwords.
  - name: Locations
    description: >-
      Location reference data: tiers, countries, regions, cities, ISPs, ASNs,
      and ZIP codes.
  - name: Account
    description: Read-only account, credit, and subscription information.
  - name: Analytics
    description: Usage analytics for your proxy packages.
paths:
  /v1/api-keys/me:
    get:
      tags:
        - API Keys
      summary: Get information about the authenticated API key
      description: >-
        Retrieve details about the API key used to authenticate the request: its
        scopes, package restriction, organization ID, and current rate-limit
        quota. Useful as a first call to verify a key works, and to check
        remaining rate-limit quota. This endpoint requires no scope — any active
        key can call it. The key secret is never returned.
      operationId: get_api_key_me_v1_api_keys_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiKeyMeResponse'
              example:
                id: 3f8a2c1e-5b6d-4e7f-8a9b-0c1d2e3f4a5b
                scopes:
                  - proxy:packages:read
                  - proxy:analytics:read
                  - account:read
                  - api-keys:read
                  - api-keys:write
                package_ids: null
                org_id: 0b9c8d7e-6f5a-4b3c-2d1e-0f9a8b7c6d5e
                rate_limit:
                  configured_limit: 5/second
                  remaining_quota: 4
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    GetApiKeyMeResponse:
      properties:
        id:
          type: string
          title: Id
        scopes:
          items:
            type: string
          type: array
          title: Scopes
        package_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Package Ids
        org_id:
          type: string
          title: Org Id
        rate_limit:
          $ref: '#/components/schemas/RateLimitInfo'
      type: object
      required:
        - id
        - scopes
        - package_ids
        - org_id
        - rate_limit
      title: GetApiKeyMeResponse
      description: Response schema for GET /v1/api-keys/me endpoint.
    RateLimitInfo:
      properties:
        configured_limit:
          type: string
          title: Configured Limit
        remaining_quota:
          type: integer
          title: Remaining Quota
      type: object
      required:
        - configured_limit
        - remaining_quota
      title: RateLimitInfo
      description: Rate limit information for an API key.
  responses:
    Unauthorized:
      description: Missing, invalid, or revoked API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
          example:
            detail: Invalid API key
    RateLimited:
      description: >-
        Rate limit exceeded (5 requests/second per API key, 500 requests/minute
        per IP). The response includes `Retry-After` (seconds),
        `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` (Unix
        time) headers — wait `Retry-After` seconds and retry.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          example:
            error: 'Rate limit exceeded: 5 per 1 second'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key secret (starts with `s_live_`). Create keys in the dashboard
        under **Settings → API keys**, or via `POST /v1/api-keys/`. Send it as
        `Authorization: Bearer <secret>`.

````