TOtotalistrading
API Keys

Create API Key

Changed on

Create a new API key for the authenticated user. The full secret is returned once in data.key, so save it immediately. Subsequent listings only show the prefix. Requires a Privy JWT (web dashboard), or an API key holding the keys:manage scope.

post/v1/api-keys

Request

Request body

namestring

Optional display name for the key.

preset'read_only' | 'trading' | 'full'

A scope bundle. With neither preset nor scopes, the key gets trading.

scopesstring[]

An explicit scope list. Overrides preset. A key can never hold a scope its creator lacks.

confirm_withdrawboolean

Required as true when the resulting key would hold funds:withdraw.

Response

API key created (full key visible once)

Changes

  • d0fb528a53f1Revision changes
    • info

      the endpoint scheme security ApiKey was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 37f56f0149e2Revision changes
    • info

      endpoint added