Skip to content

Palisade API (2.0)

The Palisade API enables programmatic interaction with the various features of the Palisade platform

Click here for the API docs
Download OpenAPI description
palisade-api.json
palisade-api.yaml
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/

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/

Addresses

Used to manage addresses

Operations

Allow Addresses (deprecated)

Used to manage legacy allow addresses

API Credentials

Used to manage credentials

Operations

Approvals

Used to manage approvals

Operations

Approvers

Used to manage approvers

Operations

Audit

Used to manage configuration for audit

Operations

Backup

Used to manage backups

Operations

Balances

Used to view balances

Operations

Compliance

Used to manage compliance

Operations

Counterparties

Used to manage counterparties

Operations

Devices

Used to manage devices

Operations

Information

Used to view information about the platform

Operations

MPC - Memberships

Used to manage MPC memberships

Operations

MPC - Quorums

Used to manage MPC quorums

Operations

MPC - Sessions

Used to manage MPC sessions

Operations

Organizations

Used to manage organizations

Operations

Policies

Used to manage connections policies

Operations

Rates

Used to retrieve rates

Operations

Sweep Configurations

Used to manage sweep configurations

Operations

Tags

Used to manage organization tags

Operations

Transactions

Used to manage transactions

Operations

Transactions - XRP

Used to manage XRP specific transactions

Operations

Users

Used to manage users

Operations

Vaults

Used to manage vaults

Operations

Vault Tags

Used to manage vault tags

Operations

Wallets

Used to manage wallets

Operations

Wallet Tags

Used to manage wallet tags

Operations

Wallet Connect

Used to manage connections

Operations

Webhooks

Used to manage webhooks

Operations

Registry

Operations

List blockchains

Request

List blockchains with advanced filtering. Supports both GET (bookmarkable) and POST (complex filters).

Security
TokenAuth
Query
filter.status.eqinteger(int32)

Equals

filter.status.notEqinteger(int32)

Not equal to

filter.status.inArray of integers(int32)

Value is in the list

filter.status.notInArray of integers(int32)

Value is not in the list

filter.status.isNullboolean

Check if field is null

filter.status.gtinteger(int32)

Greater than

filter.status.gteinteger(int32)

Greater than or equal to

filter.status.ltinteger(int32)

Less than

filter.status.lteinteger(int32)

Less than or equal to

filter.name.eqstring

Exact match

filter.name.notEqstring

Not equal to

filter.name.containsstring

Contains substring (case-insensitive)

filter.name.startsWithstring

Starts with prefix (case-insensitive)

filter.name.endsWithstring

Ends with suffix (case-insensitive)

filter.name.inArray of strings

Value is in the list

filter.name.notInArray of strings

Value is not in the list

filter.name.regexstring

Regular expression match

filter.name.isNullboolean

Check if field is null

filter.name.fuzzy.valuestring

Value to match against

filter.name.fuzzy.minSimilaritynumber(float)

Minimum similarity threshold (0.0-1.0)

filter.chainId.eqstring

Exact match

filter.chainId.notEqstring

Not equal to

filter.chainId.containsstring

Contains substring (case-insensitive)

filter.chainId.startsWithstring

Starts with prefix (case-insensitive)

filter.chainId.endsWithstring

Ends with suffix (case-insensitive)

filter.chainId.inArray of strings

Value is in the list

filter.chainId.notInArray of strings

Value is not in the list

filter.chainId.regexstring

Regular expression match

filter.chainId.isNullboolean

Check if field is null

filter.chainId.fuzzy.valuestring

Value to match against

filter.chainId.fuzzy.minSimilaritynumber(float)

Minimum similarity threshold (0.0-1.0)

filter.checksumType.eqinteger(int32)

Equals

filter.checksumType.notEqinteger(int32)

Not equal to

filter.checksumType.inArray of integers(int32)

Value is in the list

filter.checksumType.notInArray of integers(int32)

Value is not in the list

filter.checksumType.isNullboolean

Check if field is null

filter.checksumType.gtinteger(int32)

Greater than

filter.checksumType.gteinteger(int32)

Greater than or equal to

filter.checksumType.ltinteger(int32)

Less than

filter.checksumType.lteinteger(int32)

Less than or equal to

filter.chain.eqstring

Exact match

filter.chain.notEqstring

Not equal to

filter.chain.containsstring

Contains substring (case-insensitive)

filter.chain.startsWithstring

Starts with prefix (case-insensitive)

filter.chain.endsWithstring

Ends with suffix (case-insensitive)

filter.chain.inArray of strings

Value is in the list

filter.chain.notInArray of strings

Value is not in the list

filter.chain.regexstring

Regular expression match

filter.chain.isNullboolean

Check if field is null

filter.chain.fuzzy.valuestring

Value to match against

filter.chain.fuzzy.minSimilaritynumber(float)

Minimum similarity threshold (0.0-1.0)

search.termstring

Search term

search.fieldsArray of strings

Fields to search in

search.typestring

Type of search to perform

  • SEARCH_TYPE_CONTAINS: Default substring search
  • SEARCH_TYPE_STARTS_WITH: Prefix search
  • SEARCH_TYPE_EXACT: Exact match
  • SEARCH_TYPE_FUZZY: Fuzzy/similarity search
  • SEARCH_TYPE_FULLTEXT: Full-text search (future)
Enum"SEARCH_TYPE_CONTAINS""SEARCH_TYPE_STARTS_WITH""SEARCH_TYPE_EXACT""SEARCH_TYPE_FUZZY""SEARCH_TYPE_FULLTEXT"
search.minScorenumber(float)

Minimum relevance score for fuzzy/fulltext search

search.options.caseSensitiveboolean

Enable case-sensitive search (default: false)

search.options.minTermLengthinteger(int32)

Minimum search term length

search.options.maxResultsinteger(int32)

Maximum number of results to return

search.options.multiTermAndboolean

Use AND logic for multiple terms (default: false for OR)

pagination.pageSizeinteger(int32)

Number of results per page (default 50, max 1000)

pagination.pageTokenstring

Token for pagination from previous response

pagination.orderBystring

Field to order results by

pagination.orderstring

Sort order (ASC or DESC)

Enum"SORT_ORDER_ASC""SORT_ORDER_DESC"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/blockchains?filter.status.eq=0&filter.status.notEq=0&filter.status.in=0&filter.status.notIn=0&filter.status.isNull=true&filter.status.gt=0&filter.status.gte=0&filter.status.lt=0&filter.status.lte=0&filter.name.eq=string&filter.name.notEq=string&filter.name.contains=string&filter.name.startsWith=string&filter.name.endsWith=string&filter.name.in=string&filter.name.notIn=string&filter.name.regex=string&filter.name.isNull=true&filter.name.fuzzy.value=string&filter.name.fuzzy.minSimilarity=0.1&filter.chainId.eq=string&filter.chainId.notEq=string&filter.chainId.contains=string&filter.chainId.startsWith=string&filter.chainId.endsWith=string&filter.chainId.in=string&filter.chainId.notIn=string&filter.chainId.regex=string&filter.chainId.isNull=true&filter.chainId.fuzzy.value=string&filter.chainId.fuzzy.minSimilarity=0.1&filter.checksumType.eq=0&filter.checksumType.notEq=0&filter.checksumType.in=0&filter.checksumType.notIn=0&filter.checksumType.isNull=true&filter.checksumType.gt=0&filter.checksumType.gte=0&filter.checksumType.lt=0&filter.checksumType.lte=0&filter.chain.eq=string&filter.chain.notEq=string&filter.chain.contains=string&filter.chain.startsWith=string&filter.chain.endsWith=string&filter.chain.in=string&filter.chain.notIn=string&filter.chain.regex=string&filter.chain.isNull=true&filter.chain.fuzzy.value=string&filter.chain.fuzzy.minSimilarity=0.1&search.term=string&search.fields=string&search.type=SEARCH_TYPE_CONTAINS&search.minScore=0.1&search.options.caseSensitive=true&search.options.minTermLength=0&search.options.maxResults=0&search.options.multiTermAnd=true&pagination.pageSize=0&pagination.pageToken=string&pagination.orderBy=string&pagination.order=SORT_ORDER_ASC' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
blockchainsArray of objects(Blockchain configuration information)
paginationobject(v2PaginationResponse)
Response
application/json
{
  "blockchains": [
    { … }
  ],
  "pagination": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  }
}

Create a new blockchain

Request

Create a new blockchain configuration in the registry

Security
TokenAuth
Bodyapplication/jsonrequired
idstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
namestringrequired

Blockchain name

Example: "Ethereum Mainnet"
namespacestringrequired

Blockchain namespace

Example: "ethereum"
chainstring

Chain identifier

Example: "mainnet"
chainIdstring

Chain ID (for EVM chains)

Example: "1"
routingstring

Routing configuration

Example: "primary"
statusstring(v2BlockchainStatus)required
Enum"RPC_ENDPOINT_TYPE_ENABLED""RPC_ENDPOINT_TYPE_DISABLED"
supportsWalletConnectboolean

Whether blockchain supports WalletConnect

Example: true
rpcEndpointsArray of objects(v2RPCEndpoint)

RPC endpoints for the blockchain

explorersArray of objects(v2Explorer)

Block explorers for the blockchain

keystoreTypesArray of strings(v2Keystore)

Supported keystore types

Items Enum"HSM""MPC"
keyAlgorithmsArray of strings(- SECP256K1: used for evm chains and xrp ledger, supported by hsm and mpc - ED25519: used for solana, supported by mpc)

Supported key algorithms

Items Enum"SECP256K1""ED25519"
supportedEventsArray of strings

Supported blockchain events

supportedMethodsArray of strings

Supported blockchain methods

curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/blockchains \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "AVALANCHE",
    "name": "Ethereum Mainnet",
    "namespace": "ethereum",
    "chain": "mainnet",
    "chainId": "1",
    "routing": "primary",
    "status": "RPC_ENDPOINT_TYPE_ENABLED",
    "supportsWalletConnect": true,
    "rpcEndpoints": [
      {
        "url": "https://mainnet.infura.io/v3/YOUR-PROJECT-ID",
        "priority": 0,
        "type": "RPC_ENDPOINT_TYPE_HTTP"
      }
    ],
    "explorers": [
      {
        "name": "Etherscan",
        "url": "https://etherscan.io",
        "transactionFormat": "/tx/{txHash}",
        "addressFormat": "/address/{address}"
      }
    ],
    "keystoreTypes": [
      "HSM"
    ],
    "keyAlgorithms": [
      "SECP256K1"
    ],
    "supportedEvents": [
      "string"
    ],
    "supportedMethods": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
namestringrequired

Human-readable name of the blockchain

Example: "Ethereum"
namespacestringrequired

The CAIP-2 namespace identifier

Example: "eip155"
chainIdstringrequired

The chain ID (supports large numbers)

Example: "1"
rpcEndpointsArray of objects(v2RPCEndpoint)

RPC endpoints for blockchain connectivity

supportedEventsArray of strings

WalletConnect event types supported by this blockchain

supportedMethodsArray of strings

WalletConnect methods supported by this blockchain

keystoreTypesArray of strings(v2Keystore)

Supported keystore types (HSM, MPC)

Items Enum"HSM""MPC"
keyAlgorithmsArray of strings(- SECP256K1: used for evm chains and xrp ledger, supported by hsm and mpc - ED25519: used for solana, supported by mpc)

Supported key algorithms

Items Enum"SECP256K1""ED25519"
routingstringrequired

Message queue routing key base

Example: "ethereum"
statusstring(v2BlockchainStatus)required
Enum"RPC_ENDPOINT_TYPE_ENABLED""RPC_ENDPOINT_TYPE_DISABLED"
supportsWalletConnectboolean

Whether this blockchain supports WalletConnect

explorersArray of objects(v2Explorer)

Blockchain explorers for viewing transactions and addresses

createdAtstring(date-time)read-only

When the blockchain was created

updatedAtstring(date-time)read-only

When the blockchain was last updated

chainstring

Chain identifier (e.g., 'ethereum-mainnet', 'ethereum-goerli')

Example: "ethereum-mainnet"
coingeckoPlatformIdstring

CoinGecko platform identifier for sync (optional for testnets)

Example: "ethereum"
checksumTypestring(ChecksumType defines the type of address checksum used by a blockchain)
  • CHECKSUM_TYPE_NONE: No checksum (e.g., Solana)
  • CHECKSUM_TYPE_EIP55: Ethereum EIP-55
  • CHECKSUM_TYPE_BASE58CHECK: Tron Base58Check
  • CHECKSUM_TYPE_XRP: XRP Base58 with checksum (double-SHA256)
Enum"CHECKSUM_TYPE_NONE""CHECKSUM_TYPE_EIP55""CHECKSUM_TYPE_BASE58CHECK""CHECKSUM_TYPE_XRP"
blockTimeinteger(int32)

Average block time in seconds

Example: 12
confirmationBlocksinteger(int32)

Recommended number of confirmations for finality

Example: 6
Response
application/json
{
  "id": "AVALANCHE",
  "name": "Ethereum",
  "namespace": "eip155",
  "chainId": "1",
  "rpcEndpoints": [
    { … }
  ],
  "supportedEvents": [
    "string"
  ],
  "supportedMethods": [
    "string"
  ],
  "keystoreTypes": [
    "HSM"
  ],
  "keyAlgorithms": [
    "SECP256K1"
  ],
  "routing": "ethereum",
  "status": "RPC_ENDPOINT_TYPE_ENABLED",
  "supportsWalletConnect": true,
  "explorers": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "chain": "ethereum-mainnet",
  "coingeckoPlatformId": "ethereum",
  "checksumType": "CHECKSUM_TYPE_NONE",
  "blockTime": 12,
  "confirmationBlocks": 6
}

Get a blockchain

Request

Get blockchain configuration by ID

Security
TokenAuth
Path
idstringrequired

The blockchain ID to retrieve

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/blockchains/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
namestringrequired

Human-readable name of the blockchain

Example: "Ethereum"
namespacestringrequired

The CAIP-2 namespace identifier

Example: "eip155"
chainIdstringrequired

The chain ID (supports large numbers)

Example: "1"
rpcEndpointsArray of objects(v2RPCEndpoint)

RPC endpoints for blockchain connectivity

supportedEventsArray of strings

WalletConnect event types supported by this blockchain

supportedMethodsArray of strings

WalletConnect methods supported by this blockchain

keystoreTypesArray of strings(v2Keystore)

Supported keystore types (HSM, MPC)

Items Enum"HSM""MPC"
keyAlgorithmsArray of strings(- SECP256K1: used for evm chains and xrp ledger, supported by hsm and mpc - ED25519: used for solana, supported by mpc)

Supported key algorithms

Items Enum"SECP256K1""ED25519"
routingstringrequired

Message queue routing key base

Example: "ethereum"
statusstring(v2BlockchainStatus)required
Enum"RPC_ENDPOINT_TYPE_ENABLED""RPC_ENDPOINT_TYPE_DISABLED"
supportsWalletConnectboolean

Whether this blockchain supports WalletConnect

explorersArray of objects(v2Explorer)

Blockchain explorers for viewing transactions and addresses

createdAtstring(date-time)read-only

When the blockchain was created

updatedAtstring(date-time)read-only

When the blockchain was last updated

chainstring

Chain identifier (e.g., 'ethereum-mainnet', 'ethereum-goerli')

Example: "ethereum-mainnet"
coingeckoPlatformIdstring

CoinGecko platform identifier for sync (optional for testnets)

Example: "ethereum"
checksumTypestring(ChecksumType defines the type of address checksum used by a blockchain)
  • CHECKSUM_TYPE_NONE: No checksum (e.g., Solana)
  • CHECKSUM_TYPE_EIP55: Ethereum EIP-55
  • CHECKSUM_TYPE_BASE58CHECK: Tron Base58Check
  • CHECKSUM_TYPE_XRP: XRP Base58 with checksum (double-SHA256)
Enum"CHECKSUM_TYPE_NONE""CHECKSUM_TYPE_EIP55""CHECKSUM_TYPE_BASE58CHECK""CHECKSUM_TYPE_XRP"
blockTimeinteger(int32)

Average block time in seconds

Example: 12
confirmationBlocksinteger(int32)

Recommended number of confirmations for finality

Example: 6
Response
application/json
{
  "id": "AVALANCHE",
  "name": "Ethereum",
  "namespace": "eip155",
  "chainId": "1",
  "rpcEndpoints": [
    { … }
  ],
  "supportedEvents": [
    "string"
  ],
  "supportedMethods": [
    "string"
  ],
  "keystoreTypes": [
    "HSM"
  ],
  "keyAlgorithms": [
    "SECP256K1"
  ],
  "routing": "ethereum",
  "status": "RPC_ENDPOINT_TYPE_ENABLED",
  "supportsWalletConnect": true,
  "explorers": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "chain": "ethereum-mainnet",
  "coingeckoPlatformId": "ethereum",
  "checksumType": "CHECKSUM_TYPE_NONE",
  "blockTime": 12,
  "confirmationBlocks": 6
}

Transactions - Sweep

Operations

Sweep Instances

Operations