REST API

Fund Management (1.0.0)

Endpoint

Get Available Balances

POST

https://api.gemini.com

/v1/balances

Under the terms of the Gemini API Agreement, polling this endpoint may be subject to rate limiting.

This will show the available balances in the supported currencies

Please note that Gemini is currently in the process of introducing new API architecture that will impact how decimal balances are returned from this endpoint for fiat and crypto assets.

As a result of this change, requests to the balances endpoint routed via the new architecture will return fiat balances and crypto balances truncated to 15 and 19 decimal places, respectively. This change has been introduced to correct for the display of miniscule residual values that do not actually represent usable balances.

It is recommended that users floor the values returned from this endpoint to the correct precision until the migration to the new architecture has been completed.

Roles

The API key you use to access this endpoint must have the Trader, Fund Manager or Auditor role assigned. See Roles for more information.

The OAuth scope must have balances:read assigned to access this endpoint. See OAuth Scopes for more information.

Get Available Balances › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Get Available Balances › Request Body

requeststring · required
The API endpoint path
Example: /v1/balances
nonceTimestampType · required
timestamp
accountstring · required
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 place the order. Only available for exchange accounts.
Example: primary

Get Available Balances › Responses

The account balances

typestring · enum
Enum values:
exchange
Example: exchange
currencystring
The currency symbol
Example: BTC
amountnumber
The amount available
Example: 10.5
availablenumber
The amount available for trading
Example: 9
availableForWithdrawalnumber
The amount available for withdrawal
Example: 9
pendingWithdrawalnumber
The amount pending withdrawal
Example: 1
pendingDepositnumber
The amount pending deposit
Example: 0.5

Get Notional Balances

POST

https://api.gemini.com

/v1/notionalbalances/{currency}

Under the terms of the Gemini API Agreement, polling this endpoint may be subject to rate limiting.

This will show the available balances in the supported currencies as well as the notional value in the currency specified.

Please note that Gemini is currently in the process of introducing new API architecture that will impact how decimal balances are returned from this endpoint for fiat and crypto assets.

As a result of this change, requests to the notional balances endpoint routed via the new architecture will return fiat balances and crypto balances truncated to 15 and 19 decimal places, respectively. This change has been introduced to correct for the display of miniscule residual values that do not actually represent usable balances.

It is recommended that users floor the values returned from this endpoint to the correct precision until the migration to the new architecture has been completed.

Roles

The API key you use to access this endpoint must have the Trader, Fund Manager or Auditor role assigned. See Roles for more information.

The OAuth scope must have balances:read assigned to access this endpoint. See OAuth Scopes for more information.

Get Notional Balances › path Parameters

currencystring · required
Either a fiat currency, e.g. usd or gbp, or a supported crypto-currency, e.g. gusd, btc, eth, aave, etc.

Get Notional Balances › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Get Notional Balances › Request Body

requeststring · required
The literal string "/v1/notionalbalances/currency"
noncerequired
The nonce, as described in Private API Invocation

accountstring
Required for Master API keys. The name of the account within the subaccount group.

Get Notional Balances › Responses

Successful operation

currencystring
Currency code, see symbols and minimums
amountstring
The current balance
amountNotionalstring
Amount, in notional
availablestring
The amount that is available to trade
availableNotionalstring
Available, in notional
availableForWithdrawalstring
The amount that is available to withdraw
availableForWithdrawalNotionalstring
AvailableForWithdrawal, in notional

List Deposit Addresses

POST

https://api.gemini.com

/v1/addresses/{network}

Under the terms of the Gemini API Agreement, polling this endpoint may be subject to rate limiting. This endpoint is currently restricted further than our standard rate limiting to a rate of 1 request per 2 seconds per subaccount. This rate is subject to change and will be updated here accordingly.

Roles

The API key you use to access this endpoint must have the Trader, Fund Manager or Auditor role assigned. See Roles for more information.

The OAuth scope must have addresses:read or addresses:create assigned to access this endpoint. See OAuth Scopes for more information.

List Deposit Addresses › path Parameters

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

List Deposit Addresses › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

List Deposit Addresses › Request Body

requeststring · required
The literal string "/v1/addresses/network"
noncerequired
The nonce, as described in Private API Invocation

timestamp
Only returns addresses created on or after this timestamp
accountstring
Required for Master API keys. The name of the account within the subaccount group.

List Deposit Addresses › Responses

Successful operation

addressstring
String representation of the cryptocurrency address
timestamp
timestamp
labelstring
If you provided a label when creating the address, it will be echoed back here
memostring
It would be present if applicable, it will be present for cosmos address
networkstring
The blockchain network for the address

Create New Deposit Address

POST

https://api.gemini.com

/v1/deposit/{network}/newAddress

Roles

The API key you use to access this endpoint must have the Fund Manager role assigned. See Roles for more information.

The OAuth scope must have addresses:create assigned to access this endpoint. See OAuth Scopes for more information.

Create New Deposit Address › path Parameters

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

Create New Deposit Address › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Create New Deposit Address › Request Body

requeststring · required
The literal string "/v1/deposit/network/newAddress"
noncerequired
The nonce, as described in Private API Invocation

labelstring
A label for the address
legacyboolean
Whether to generate a legacy P2SH-P2PKH litecoin address. False by default.
accountstring
Required for Master API keys. The name of the account within the subaccount group.

Create New Deposit Address › Responses

Successful operation

addressstring
String representation of the cryptocurrency address
timestamp
timestamp
labelstring
If you provided a label when creating the address, it will be echoed back here
memostring
It would be present if applicable, it will be present for cosmos address
networkstring
The blockchain network for the address

List Past Transfers

POST

https://api.gemini.com

/v1/transfers

Under the terms of the Gemini API Agreement, polling this endpoint may be subject to rate limiting. This endpoint is currently restricted further than our standard rate limiting to a rate of 1 request per 5 seconds per subaccount. This rate is subject to change and will be updated here accordingly.

This endpoint shows deposits and withdrawals in the supported currencies. When deposits show as Advanced or Complete they are available for trading.

This endpoint does not currently show cancelled advances, returned outgoing wires or ACH transactions, or other exceptional transaction circumstances.

Fiat transfers between non-derivative and derivatives accounts are prohibited.

Roles

The API key you use to access this endpoint must have the Trader, Fund Manager or Auditor role assigned. See Roles for more information.

The OAuth scope must have history:read assigned to access this endpoint. See OAuth Scopes for more information.

List Past Transfers › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

List Past Transfers › Request Body

requeststring · required
The literal string "/v1/transfers"
noncerequired
The nonce, as described in Private API Invocation

currencystring
Currency code, see symbols and minimums
timestamp
Only return transfers after this timestamp
limit_transfersinteger
The maximum number of transfers to return. The default is 10 and the maximum is 50.
accountstring
Required for Master API keys. The name of the account within the subaccount group.
show_completed_deposit_advancesboolean
Whether to display completed deposit advances. False by default.

List Past Transfers › Responses

Successful operation

typestring · enum
Enum values:
Deposit
Withdrawal
statusstring · enum
Enum values:
Complete
Pending
timestampms
timestamp
eidinteger
The transfer ID
currencystring
The currency transferred
amountstring
The amount transferred
txHashstring
The transaction hash if applicable

List Custody Fee Transfers

POST

https://api.gemini.com

/v1/custodyaccountfees

Under the terms of the Gemini API Agreement, polling this endpoint may be subject to rate limiting. This endpoint is currently restricted further than our standard rate limiting to a rate of 1 request per 5 seconds per subaccount. This rate is subject to change and will be updated here accordingly. This is the same limit as the transfers endpoint. One call to one affects the other.

This endpoint shows Custody fee records in the supported currencies.

Roles

The API key you use to access this endpoint must have the Trader, Fund Manager or Auditor role assigned. See Roles for more information.

The OAuth scope must have history:read assigned to access this endpoint. See OAuth Scopes for more information.

List Custody Fee Transfers › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

List Custody Fee Transfers › Request Body

requeststring · required
The literal string "/v1/custodyaccountfees"
noncerequired
The nonce, as described in Private API Invocation

timestamp
Only return Custody fee records on or after this timestamp
limit_transfersinteger
The maximum number of Custody fee records to return. The default is 10 and the maximum is 50.
accountstring
Required for Master API keys. The name of the account within the subaccount group.

List Custody Fee Transfers › Responses

Successful operation

txTimeinteger
Time of Custody fee record in milliseconds
feeAmountstring
The fee amount charged
feeCurrencystring
Currency that the fee was paid in
eidinteger
Custody fee event id
eventTypestring
Custody fee event type

Withdraw Crypto Funds

POST

https://api.gemini.com

/v1/withdraw/{currency}

Before you can withdraw cryptocurrency funds to an approved address, you need three things:

You must have an approved address list for your account
The address you want to withdraw funds to needs to already be on that approved address list
An API key with the Fund Manager role added

If you would like to withdraw via API to addresses that are not on your approved address list, please reach out to trading@gemini.com. We can enable this feature for you provide a set of approved IP addresses. This functionality is only available for exchange accounts. Pre-approved IP addresses and addresses added to your approved address list are required to enable withdrawal APIs for custody accounts.

See Roles for more information on how to add the Fund Manager role to the API key you want to use.

Roles

The API key you use to access this endpoint must have the Fund Manager role assigned. See Roles for more information.

The OAuth scope must have crypto:send assigned to access this endpoint. See OAuth Scopes for more information.

Withdraw Crypto Funds › path Parameters

currencystring · required
Either a fiat currency, e.g. usd or gbp, or a supported crypto-currency, e.g. gusd, btc, eth, aave, etc.

Withdraw Crypto Funds › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Withdraw Crypto Funds › Request Body

requeststring · required
The literal string "/v1/withdraw/currency"
noncerequired
The nonce, as described in Private API Invocation
addressstring · required
The destination address
amountstring · required
The amount to withdraw

client_transfer_idstring
A client-supplied unique identifier for the withdrawal
accountstring
Required for Master API keys. The name of the account within the subaccount group.
memostring
For addresses that require a memo

Withdraw Crypto Funds › Responses

Successful operation

addressstring
Standard string format of the withdrawal destination address
amountstring
The withdrawal amount
feestring
The fee in kind applied to the transaction
withdrawalIdstring
A unique ID for the withdrawal
messagestring
A human-readable English string describing the withdrawal

Get Gas Fee Estimation

POST

https://api.gemini.com

/v1/withdraw/{currencyCodeLowerCase}/feeEstimate

API users will not be aware of the transfer fees before starting the withdrawal process. This endpoint allows you to find out the estimated gas fees before you start a withdrawal.

Roles

The API key you use to access this endpoint can have the Trader, Fund Manager, Auditor, WealthManager or Administrator role assigned. See Roles for more information.

Get Gas Fee Estimation › path Parameters

currencyCodeLowerCasestring · required
The supported cryptocurrency code in lowercase (e.g eth, btc)

Get Gas Fee Estimation › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Get Gas Fee Estimation › Request Body

requeststring · required
The string /v1/withdraw/{currencyCodeLowerCase}/feeEstimate where :currencyCodeLowerCase is replaced with the currency code of a supported crypto-currency, e.g. eth, aave, etc. See Symbols and minimums
Example: /v1/withdraw/eth/feeEstimate
noncerequired
The nonce, as described in Private API Invocation
addressstring · required
Standard string format of cryptocurrency address
Example: 0x31c2105b8dea834167f32f7ea7d877812e059230
amountstring · required
Quoted decimal amount to withdraw
Example: 0.01
accountstring · required
The name of the account within the subaccount group.
Example: primary

Get Gas Fee Estimation › Responses

JSON response for ETH withdrawal

currencystring
Currency code, see symbols.
Example: ETH
feestring
The estimated gas fee
Example: {currency: 'ETH', value: '0'}
isOverrideboolean
Value that shows if an override on the customer's account for free withdrawals exists
Example: false
monthlyLimitinteger
Total nunber of allowable fee-free withdrawals
Example: 1
monthlyRemaininginteger
Total number of allowable fee-free withdrawals left to use
Example: 1

Add Bank

POST

https://api.gemini.com

/v1/payments/addbank

The add bank API allows for banking information to be sent in via API. However, for the bank to be verified, you must still send in a wire for any amount from the bank account.

Roles

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

The OAuth scope must have banks:create assigned to access this endpoint. See OAuth Scopes for more information.

Add Bank › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Add Bank › Request Body

requeststring · required
The literal string "/v1/payments/addbank"
noncerequired
The nonce, as described in Private API Invocation
accountnumberstring · required
Account number of bank account to be added
routingstring · required
Routing number of bank account to be added
typestring · enum · required
Type of bank account to be added. Accepts checking or savings
Enum values:
checking
savings
namestring · required
The name of the bank account as shown on your account statements

accountstring
Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Master API keys can get all account names using the Get Accounts endpoint.

Add Bank › Responses

Successful operation

referenceIdstring
Reference ID for the new bank addition request. Once received, send in a wire from the requested bank account to verify it and enable withdrawals to that account.

Add Bank CAD

POST

https://api.gemini.com

/v1/payments/addbank/cad

The add bank API allows for CAD banking information to be sent in via API. However, for the bank to be verified, you must still send in a wire for any amount from the bank account.

Roles

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

The OAuth scope must have banks:create assigned to access this endpoint. See OAuth Scopes for more information.

Add Bank CAD › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Add Bank CAD › Request Body

requeststring · required
The literal string "/v1/payments/addbank/cad"
noncerequired
The nonce, as described in Private API Invocation
swiftcodestring · required
The account SWIFT code
accountNumberstring · required
Account number of bank account to be added
typestring · enum · required
Type of bank account to be added. Accepts checking or savings
Enum values:
checking
savings
namestring · required
The name of the bank account as shown on your account statements

institutionNumberstring
The institution number of the account - optional but recommended.
branchnnumberstring
The branch number - optional but recommended.
accountstring
Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Master API keys can get all account names using the Get Accounts endpoint.

Add Bank CAD › Responses

Successful operation

resultstring
Status of the request. "OK" indicates the account has been created successfully.

List Payment Methods

POST

https://api.gemini.com

/v1/payments/methods

The payments methods API will return data on balances in the account and linked banks.

Roles

The API key you use to access this endpoint can be either a Master or Account level key with any role assigned. See Roles for more information.

The OAuth scope must have banks:read assigned to access this endpoint. See OAuth Scopes for more information.

List Payment Methods › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

List Payment Methods › Request Body

requeststring · required
The literal string "/v1/payments/methods"
noncerequired
The nonce, as described in Private API Invocation

accountstring
Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Master API keys can get all account names using the Get Accounts endpoint.

List Payment Methods › Responses

Successful operation

balancesobject[]
Array of JSON objects with available fiat currencies and their balances.
banksobject[]
Array of JSON objects with banking information

List Approved Addresses

POST

https://api.gemini.com

/v1/approvedAddresses/account/{network}

Allows viewing of Approved Address list.

Roles

This API can accept any role. See Roles for more information.

List Approved Addresses › path Parameters

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

List Approved Addresses › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

List Approved Addresses › Request Body

requeststring · required
The literal string "/v1/approvedAddresses/account/:network" where :network can be bitcoin, ethereum, bitcoincash, litecoin, zcash, filecoin, dogecoin, tezos, solana, polkadot, avalanche, cosmos, or xrpl
noncerequired
The nonce, as described in Private API Invocation

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 view the approved address list.

List Approved Addresses › Responses

Successful operation

approvedAddressesobject[]
Array of approved addresses on both the account and group level.

Remove Approved Address

POST

https://api.gemini.com

/v1/approvedAddresses/{network}/remove

Allows for removal of active or time-pending addresses from the Approved Address list. Addresses that are pending approval from another user on the account cannot be removed via API.

Roles

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

Remove Approved Address › path Parameters

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

Remove Approved Address › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Remove Approved Address › Request Body

requeststring · required
The literal string "/v1/approvedAddresses/:network/remove" where :network can be bitcoin, ethereum, bitcoincash, litecoin, zcash, filecoin, dogecoin, tezos, solana, polkadot, avalanche, cosmos, or xrpl
noncerequired
The nonce, as described in Private API Invocation
addressstring · required
A string of the address to be removed from the approved address list.

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 remove the approved address.

Remove Approved Address › Responses

Successful operation

messagestring
Upon successful request, the endpoint will return a string indicating the address and whether it was removed from the group-level or account-level approved address list.

Transfer Between Accounts

POST

https://api.gemini.com

/v1/account/transfer/{currency}

This API allows you to execute an internal transfer between any two accounts within your Master Group. In the scenario of exchange account to exchange account there will be no activity on a blockchain network. All other combinations will result in a movement of funds on a blockchain network.

Gemini Custody account withdrawals will not occur until the daily custody run occurs. In the case of funds moving from a Gemini Custody account to a Gemini Exchange account, the exchange account will get a precredit for the amount to be received. The exchange account will be able to trade these funds but will be unable to withdraw until the funds are processed on the blockchain and received.

Gemini Custody accounts request withdrawals to approved addresses in all cases and require the request to come from an approved IP address. Please reach out to trading@gemini.com to enable API withdrawals for custody accounts.

Gemini Custody accounts do not support fiat currency transfers.

Fiat transfers between non-derivative and derivatives accounts are prohibited.

Roles

The API key you use to access this endpoint must be a Master level key and have the Fund Manager role assigned. See Roles for more information.

Transfer Between Accounts › path Parameters

currencystring · required
Either a fiat currency, e.g. usd or gbp, or a supported crypto-currency, e.g. gusd, btc, eth, aave, etc.

Transfer Between Accounts › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Transfer Between Accounts › Request Body

requeststring · required
The string /v1/account/transfer/:currency where :currency is replaced with either usd or a supported crypto-currency, e.g. gusd, btc, eth, aave, etc. See Symbols and minimums.
noncerequired
The nonce, as described in Private API Invocation
sourceAccountstring · required
Nickname of the account you are transferring from. Use the Get Accounts endpoint to get all account names in the group.
targetAccountstring · required
Nickname of the account you are transferring to. Use the Get Accounts endpoint to get all account names in the group.
amountstring · required
Quoted decimal amount to withdraw

clientTransferIdstring
A unique identifier for the internal transfer, in uuid4 format
withdrawalIdstring
Unique ID of the requested withdrawal.

Transfer Between Accounts › Responses

JSON response

fromAccountstring
Source account where funds are sent from
toAccountstring
Target account to receive funds in the internal transfer
amountstring
Quantity of assets being transferred
feestring
Fee taken for the transfer. Exchange account to exchange account transfers will always be free and will not be deducted from the free monthly transfer amount for that account.
currencystring
Display Name. Can be Bitcoin, Ether, Zcash, Litecoin, Dollar, etc.
withdrawalIdstring
Excludes exchange to exchange. Unique ID of the requested withdrawal
uuidstring
Only for exchange to exchange. Unique ID of the completed transfer
messagestring
Message describing result of withdrawal. Will inform of success, failure, or pending blockchain transaction.
txHashstring
Only for Ethereum network transfers. Excludes exchange to exchange transfers. Transaction hash for ethereum network transfer.

Get Transaction History

POST

https://api.gemini.com

/v1/transactions

Under the terms of the Gemini API Agreement, polling this endpoint may be subject to rate limiting. Due to current limitations with the v1/transactions endpoint, historical data can only be returned for dates _after_ August 1st, 2022. For any requests to this endpoint, please ensure that the value provided for _timestamp_nanos_ as after this date.

This endpoint shows trade detail and transactions. There is a continuation_token that is a pagination token used for subsequent requests.

Roles

The API key you use to access this endpoint must have the Trader, Fund Manager or Auditor role assigned and have the master account scope. See Roles for more information.

The OAuth scope must have history:read assigned to access this endpoint. See OAuth Scopes for more information.

Get Transaction History › 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
Default: text/plain
Content-Lengthstring
Default: 0
Cache-Controlstring
Default: no-cache

Get Transaction History › Request Body

requeststring · required
The literal string "/v1/transactions"
noncerequired
The nonce, as described in Private API Invocation

timestamp_nanos
Only return transfers on or after this timestamp in nanos. If this is defined, do not define “continuation_token”.
limitinteger
The maximum number of transfers to return. The default is 100 and the maximum is 300.
Default: 100
continuation_tokenstring
For subsequent requests, use the returned continuation_token value for next page. If this is defined, do not define “timestamp_nanos”.

Get Transaction History › Responses

The response will be an array of JSON objects, sorted by trade and transfer as well as a continuationToken to be used in subsequent requests.

resultsarray
Results will contain either a list of Trade or Transfer responses

Orders Session