Interface RestRequestGetWallets

  • HTTP Request: GET /v4/wallets
  • Endpoint Security: User Data
  • API Key Scope: Read

See

interface RestRequestGetWallets {
    nonce: string;
    wallet?: string;
    wallets?: string | string[];
    includePositions?: boolean;
}

Hierarchy (view full)

Properties

nonce wallet? wallets? includePositions?

Properties

nonce

nonce: string

User data and trade endpoints requests must include a nonce.

  • MUST be a version 1 UUID
  • Nonces may be supplied with or without hyphens.

Remarks

Version 1 UUIDs encode a timestamp in addition to other unique information, and thus serve both to prevent replay attacks as well as to enforce request timing. As a result, nonces MUST be generated at the time of a request.

Optional wallet

wallet?: string

The wallet address to use for the request.

Optional wallets

wallets?: string | string[]

To filter for multiple associated wallets, you may provide a wallets property with an array of wallet addresses to return.

  • This is merged with the wallet property if provided.
  • This will throw an error if any of the requested wallets are not associated with your account.
  • Omitting wallets and wallet will return all wallets for the account.

Optional includePositions

includePositions?: boolean

If false, do not include a positions array in the response.

Default Value

true

Settings

Member Visibility

Theme

On This Page

noncewalletwalletsincludePositions