Fund Management

Create New Approved Address

Allows for creation of an approved withdrawal address. Once the request is made, the 7 day waiting period will begin. Please note that all approved address requests are subject to the 7 day waiting period.

If you add an address using an account-scoped API key, then the address will be added to your account specific approved address list. If you use a master-scoped API key, the address will be added to your group-level approved address list unless you specify an account.

This endpoint is subject to additional security constraints and is only accessible via API keys which have configured Trusted IP controls.

Please reach out to trading@gemini.com if you have any questions about approved addresses.

Roles

This API requires the FundManager role. See Roles for more information.

post/v1/approvedAddresses/{network}/request

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/approvedAddresses/{network}/request
  • Auth
    API key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD

Path parameters

networkstring required

Can be bitcoin, ethereum, bitcoincash, litecoin, zcash, filecoin, dogecoin, tezos, solana, polkadot, avalanche, cosmos, or xrpl

Headers

X-GEMINI-APIKEYstring required

Your API key

X-GEMINI-SIGNATUREstring required

HEX-encoded HMAC-SHA384 of payload signed with API secret

X-GEMINI-PAYLOADstring required

Base64-encoded JSON payload

Content-Typestring
Content-Lengthstring
Cache-Controlstring

Request body

requeststring required

The literal string "/v1/approvedAddresses/:network/request" where :network can be bitcoin, ethereum, bitcoincash, litecoin, zcash, filecoin, dogecoin, tezos, solana, polkadot, avalanche, cosmos, or xrpl

addressstring required

A string of the address to be added to the approved address list.

labelstring required

The label of the approved address.

accountstring

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Specifies the account on which you intend to add the approved address.

memostring

it would be present if applicable, it will be present for cosmos address.

Example request

{
  "nonce": "1495127793000"
}

Response

Successful operation

messagestring

Status or confirmation message for the approved address request or removal.

resultstring

Result status (e.g. ok).

Changes

No recorded changes to this operation across all 1 revision of this API.