Skip to main content

Get Deposit Addresses

POST 

/private/DepositAddresses

Retrieve (or generate a new) deposit addresses for a particular asset and method.

API Key Permissions Required: Funds permissions - Query

Request

Body

required
    nonce int64required

    Nonce used in construction of API-Sign header

    asset stringrequired

    Asset being deposited

    method stringrequired

    Name of the deposit method

    new boolean

    Whether or not to generate a new address

    amount object

    Amount you wish to deposit (only required for method=Bitcoin Lightning)

    oneOf

    string

Responses

Deposit addresses retrieved.

Schema
    result object[]
  • Array [
  • address string

    Deposit Address

    expiretm string

    Expiration time in unix timestamp, or 0 if not expiring

    new boolean

    Whether or not address has ever been used

    tag string

    Contains tags for XRP deposit addresses and memos for STX, XLM, and EOS deposit addresses

  • ]
  • error string[]
Loading...