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

# Get account

> The API key this request was made with, as the server sees it: name, environment, permissions and limits. Never returns the secret. Call it to check a key works.



## OpenAPI

````yaml api-reference/openapi.json GET /account
openapi: 3.1.0
info:
  title: updown Trade API
  version: 1.0.0
  description: >-
    Public REST API. Market data needs no key; `/account` (and order entry, when
    it ships) takes an API key. Prices are dollar strings on the 1¢ grid, counts
    are contract strings, times are epoch ms. Generated from packages/protocol —
    do not edit by hand.
servers:
  - url: https://api.updown.fast/trade-api/v1
    description: production
security: []
paths:
  /account:
    get:
      summary: Get account
      description: >-
        The API key this request was made with, as the server sees it: name,
        environment, permissions and limits. Never returns the secret. Call it
        to check a key works.
      operationId: getAccount
      responses:
        '200':
          description: The key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '400':
          description: Invalid request (code BAD_REQUEST).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            No key, or one that isn't valid — revoked, expired, wrong
            environment or IP (code UNAUTHORIZED).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited (code RATE_LIMITED); wait `Retry-After` seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The book could not be read (code EXCHANGE_UNAVAILABLE); retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    AccountResponse:
      type: object
      properties:
        account:
          type: object
          properties:
            key_id:
              type: string
            key_name:
              type: string
            environment:
              type: string
              enum:
                - live
                - test
            scopes:
              type: array
              items:
                type: string
                enum:
                  - read
                  - trade
            limits:
              type: object
              properties:
                max_order_usd:
                  type: number
                max_daily_usd:
                  type: number
                max_open_orders:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                markets:
                  type: array
                  items:
                    type: string
              additionalProperties: false
            server_time_ms:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - key_id
            - key_name
            - environment
            - scopes
            - limits
            - server_time_ms
          additionalProperties: false
      required:
        - account
      additionalProperties: false
    Error:
      type: object
      properties:
        code:
          type: string
          enum:
            - BAD_REQUEST
            - NOT_FOUND
            - SERIES_NOT_FOUND
            - MARKET_NOT_FOUND
            - METHOD_NOT_ALLOWED
            - RATE_LIMITED
            - UNAUTHORIZED
            - INTERNAL_ERROR
            - EXCHANGE_UNAVAILABLE
        message:
          type: string
        details:
          type: string
      required:
        - code
        - message
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from your account: `Authorization: Bearer
        udk_<live|test>_<id>_<secret>`.

````

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