# Palisade API The Palisade API enables programmatic interaction with the various features of the Palisade platform Version: 2.0 ## Servers Sandbox server (uses TESTNET data, private keys and accounts) ``` https://api.sandbox.palisade.co ``` Palisade server (uses MAINNET data, private keys and accounts) ``` https://api.palisade.co ``` ## Security ### TokenAuth Type: apiKey In: header Name: Authorization ## Download OpenAPI description [Palisade API](https://docs.ripple.com/_bundle/products/wallet/api-docs/palisade-api/palisade-api.yaml) ## Addresses Used to manage addresses ### List organization addresses - [GET /v2/addresses](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/addresses/counterpartyservice_listglobaladdresses.md): List all addresses within the organization ### List counterparty addresses - [GET /v2/counterparties/{counterpartyId}/addresses](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/addresses/counterpartyservice_listaddresses.md): List all addresses within a counterparty ### Create addresses - [POST /v2/counterparties/{counterpartyId}/addresses](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/addresses/counterpartyservice_createaddress.md): Create a new address ### Get addresses - [GET /v2/counterparties/{counterpartyId}/addresses/{addressId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/addresses/counterpartyservice_getaddress.md): Get an address ### Delete addresses - [DELETE /v2/counterparties/{counterpartyId}/addresses/{addressId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/addresses/counterpartyservice_deleteaddress.md): Delete an address ## API Credentials Used to manage credentials ### Client credentials exchange - [POST /v2/credentials/oauth/token](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/api-credentials/credentialservice_exchangecredential.md): OAuth client credentials exchange for access token ## Balances Used to view balances ### Get Organization Balances - [GET /v2/balances](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/balances/balanceservice_getorgbalances.md): Get the balance of an organization ### Get Vault Balances - [GET /v2/vaults/{vaultId}/balances](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/balances/balanceservice_getvaultbalances.md): Get the balances of a vault ### Get Wallet Balances - [GET /v2/vaults/{vaultId}/wallets/{walletId}/balances](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/balances/balanceservice_getwalletbalances.md): Get the balances of a wallet ### Sync Wallet Balances - [POST /v2/vaults/{vaultId}/wallets/{walletId}/balances/sync](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/balances/balanceservice_syncwalletbalances.md): Trigger a refresh of the balances for a wallet. Note: This only syncs balances for assets already known to the system. It will not discover new tokens that were received but not yet tracked. ## Counterparties Used to manage counterparties ### List counterparties - [GET /v2/counterparties](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/counterparties/counterpartyservice_listcounterparties.md): List counterparties ### Create counterparties - [POST /v2/counterparties](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/counterparties/counterpartyservice_createcounterparty.md): Create a new counterparty ### Get counterparties - [GET /v2/counterparties/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/counterparties/counterpartyservice_getcounterparty.md): Get a counterparty ### Delete counterparties - [DELETE /v2/counterparties/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/counterparties/counterpartyservice_deletecounterparty.md): Delete a counterparty ### Update counterparties - [PUT /v2/counterparties/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/counterparties/counterpartyservice_updatecounterparty.md): Update a counterparty ## Policies Used to manage connections policies ### List organization wallet limits - [GET /v2/policy-rules/limits](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/policies/policyservice_listglobalwalletlimits.md): List all wallet limits within the organization ### List wallet limit policies - [GET /v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/policies/policyservice_listwalletlimits.md): List wallet limit policies for the specified wallet ### Create a wallet limit policy - [PUT /v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/policies/policyservice_createwalletlimit.md): Create a wallet limit policy for the specified wallet ### Get a wallet limit policy - [GET /v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/policies/policyservice_getwalletlimit.md): Get the specified wallet limit policy ### Delete a wallet limit policy - [DELETE /v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/policies/policyservice_deletewalletlimit.md): Delete the specified wallet limit policy ## Sweep Configurations Used to manage sweep configurations ### Trigger a sweep configuration - [POST /v2/workflows/sweep/{id}/trigger](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/sweep-configurations/sweepservice_triggersweepconfiguration.md): Manually trigger a single sweep configuration based on its ID ## Tags Used to manage organization tags ### List all tags for the organization - [GET /v2/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/tags/vaultservice_listglobaltags.md): List all wallet and vault tags for the organization ## Transactions Used to manage transactions ### Estimate the fee for a transfer transaction - [POST /v2/transactions/transfer/estimate-fee](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_estimatetransferfee.md): Estimate the fee for a transfer transaction ### List wallet transactions - [GET /v2/vaults/{vaultId}/wallets/{walletId}/transactions](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_listwallettransactions.md): List all transactions for a given wallet ### Create a new raw transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/raw](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_rawtransaction.md): Create a new raw transaction, and optionally publish it to the blockchain ### (BETA) Create a new sign plaintext transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/sign-plaintext](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_signplaintext.md): (BETA) Create a new sign plaintext transaction ### Create a new transfer transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/transfer](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_transfertransaction.md): Create a new transfer transaction ### Get a transaction - [GET /v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_gettransaction.md): Get a transaction by ID ### Freeze a transaction - [PUT /v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}/freeze](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_freezetransaction.md): Freeze a transaction by ID ### Unfreeze a transaction - [PUT /v2/vaults/{vaultId}/wallets/{walletId}/transactions/{transactionId}/unfreeze](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions/transactionsservice_unfreezetransaction.md): Unfreeze a transaction by ID ## Transactions - XRP Used to manage XRP specific transactions ### Create a new XRP Account Set transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/account-set](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submitaccountset.md): Create a new XRP Account Set transaction ### Create a new XRP AMM Create transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/amm-create](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submitammcreate.md): Create a new XRP AMM Create transaction ### Create a new XRP AMM Deposit transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/amm-deposit](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submitammdeposit.md): Create a new XRP AMM Deposit transaction ### Create a new XRP AMM Withdraw transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/amm-withdraw](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submitammwithdraw.md): Create a new XRP AMM Withdraw transaction ### Create a new XRP Clawback transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/clawback](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submitclawback.md): Create a new XRP Clawback transaction to recover issued tokens ### Create a new XRP Offer Cancel transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/offer-cancel](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submitoffercancel.md): Create a new XRP Offer Cancel transaction ### Create a new XRP Offer Create transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/offer-create](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submitoffercreate.md): Create a new XRP Offer Create transaction ### Create a new XRP SignerList Set transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/signer-list-set](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submitsignerlistset.md): Create a new XRP SignerList Set transaction ### Create a new XRP Trust Set transaction - [POST /v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/trust-set](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-xrp/transactionsservice_submittrustset.md): Create a new XRP Trust Set transaction ## Vaults Used to manage vaults ### List vaults - [GET /v2/vaults](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_listvaults.md): List all vaults within the organization ### Create a vault - [POST /v2/vaults](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_createvault.md): Create a new vault ### Get a vault - [GET /v2/vaults/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_getvault.md): Get a vault by ID ### Update a vault - [PUT /v2/vaults/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_updatevault.md): Update a vault's name and description by ID ## Vault Tags Used to manage vault tags ### List all vault tags for the organization - [GET /v2/vaults/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/vault-tags/vaultservice_listglobalvaulttags.md): List all vault tags for the organization ### List tags for the vault - [GET /v2/vaults/{vaultId}/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/vault-tags/vaultservice_listvaulttags.md): List all tags for the vault ### Delete a vault tag - [DELETE /v2/vaults/{vaultId}/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/vault-tags/vaultservice_deletevaulttag.md): Delete a vault tag from a vault ### Add a new vault tag - [POST /v2/vaults/{vaultId}/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/vault-tags/vaultservice_addvaulttag.md): Add a new vault tag to a vault ## Wallets Used to manage wallets ### List vault wallets - [GET /v2/vaults/{vaultId}/wallets](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_listvaultwallets.md): List all wallets within a vault ### Create a wallet - [POST /v2/vaults/{vaultId}/wallets](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_createwallet.md): Create a new HSM or MPC wallet within a vault ### Get a wallet - [GET /v2/vaults/{vaultId}/wallets/{walletId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_getwallet.md): Get a wallet by ID ### Delete a wallet - [DELETE /v2/vaults/{vaultId}/wallets/{walletId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_deletewallet.md): Delete a wallet by ID (A wallet can only be deleted if it is in PROVISIONING_FAILED status) ### Update a wallet - [PUT /v2/vaults/{vaultId}/wallets/{walletId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_updatewallet.md): Update a wallet's name and description by ID ### Get a wallet nonce/sequence - [GET /v2/vaults/{vaultId}/wallets/{walletId}/sequence](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_getwalletsequence.md): Get blockchain nonce/sequence of a specific wallet by ID ### Update a wallet's settings - [PUT /v2/vaults/{vaultId}/wallets/{walletId}/settings](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_updatewalletsettings.md): Update a wallet's settings by ID ### List organization wallets - [GET /v2/wallets](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_listglobalwallets.md): List all wallets within the organization ### Get a wallet by ID - [GET /v2/wallets/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallets/vaultservice_getwalletbyid.md): Get a wallet by its unique ID ## Wallet Tags Used to manage wallet tags ### List all wallet tags in vault - [GET /v2/vaults/{vaultId}/wallets/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallet-tags/vaultservice_listwallettagsinvault.md): List all tags from all wallets in the vault ### List wallet tags for the wallet - [GET /v2/vaults/{vaultId}/wallets/{walletId}/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallet-tags/vaultservice_listwallettags.md): List all wallet tags for the wallet ### Delete a wallet tag - [DELETE /v2/vaults/{vaultId}/wallets/{walletId}/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallet-tags/vaultservice_deletewallettag.md): Delete a wallet tag from a wallet ### Add a new wallet tag - [POST /v2/vaults/{vaultId}/wallets/{walletId}/tags](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/wallet-tags/vaultservice_addwallettag.md): Add a new wallet tag to a wallet ## Webhooks Used to manage webhooks ### List webhooks - [GET /v2/webhooks](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/webhooks/webhookservice_listwebhooks.md): List webhooks ### Create webhooks - [POST /v2/webhooks](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/webhooks/webhookservice_createwebhook.md): Create a new webhook ### Get webhooks - [GET /v2/webhooks/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/webhooks/webhookservice_getwebhook.md): Get a single webhook based on its ID ### Delete webhooks - [DELETE /v2/webhooks/{id}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/webhooks/webhookservice_deletewebhook.md): Delete a single webhook based on its ID ### List subscriptions - [GET /v2/webhooks/{webhookId}/subscriptions](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/webhooks/webhookservice_listsubscriptions.md): List subscriptions ### Create webhook subscriptions - [POST /v2/webhooks/{webhookId}/subscriptions](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/webhooks/webhookservice_createsubscriptions.md): Create one or more new webhook subscription ### Get subscriptions - [GET /v2/webhooks/{webhookId}/subscriptions/{subscriptionId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/webhooks/webhookservice_getsubscription.md): Get a single subscription based on its ID ### Delete subscriptions - [DELETE /v2/webhooks/{webhookId}/subscriptions/{subscriptionId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/webhooks/webhookservice_deletesubscription.md): Delete a single subscription based on its ID ## Transactions - Sweep ### List transactions for a sweep instance - [GET /v2/transactions/sweep/{sweepId}](https://docs.ripple.com/products/wallet/api-docs/palisade-api/palisade-api/transactions-sweep/transactionsservice_listsweepinstancetransactions.md): List all transactions for a given sweep instance