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/

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

Get import details

Request

Get details of a specific import operation

Security
TokenAuth
Path
importIdstringrequired

Import ID to retrieve

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/sync/imports/{importId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
importIdstring

Unique identifier for this import

batchIdstring

Import batch identifier

sourcestring

Source of the import (e.g., 'coingecko')

statusstring

Current status of the import

Example: "completed"
triggeredBystring

User or system that triggered the import

dryRunboolean

Whether this was a dry-run

startedAtstring(date-time)

When the import started

completedAtstring(date-time)

When the import completed

totalProcessedinteger(int32)

Total number of items processed

newAssetsinteger(int32)

Number of new assets created

updatedAssetsinteger(int32)

Number of assets updated

failedAssetsinteger(int32)

Number of failed assets

conflictsArray of objects(ConflictReport describes a conflict encountered during sync)

Conflicts encountered during import

errorMessagestring

Error message if import failed

Response
application/json
{
  "importId": "string",
  "batchId": "string",
  "source": "string",
  "status": "completed",
  "triggeredBy": "string",
  "dryRun": true,
  "startedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "totalProcessed": 0,
  "newAssets": 0,
  "updatedAssets": 0,
  "failedAssets": 0,
  "conflicts": [
    { … }
  ],
  "errorMessage": "string"
}

Get sync status

Request

Get the current status of the sync scheduler

Security
TokenAuth
curl -i -X GET \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/sync/status \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
enabledboolean

Whether sync is enabled

runningboolean

Whether sync is currently running

schedulestring

Cron schedule for automatic sync

Example: "0 0 0 * * 0"
nextRunstring

Next scheduled sync time

Example: "2024-08-11T00:00:00Z"
dryRunboolean

Whether dry-run mode is enabled

batchSizeinteger(int32)

Batch size for processing

Response
application/json
{
  "enabled": true,
  "running": true,
  "schedule": "0 0 0 * * 0",
  "nextRun": "2024-08-11T00:00:00Z",
  "dryRun": true,
  "batchSize": 0
}

Trigger asset sync

Request

Manually trigger a synchronization of assets from CoinGecko

Security
TokenAuth
Bodyapplication/jsonrequired
dryRunboolean

Whether to run in dry-run mode (no changes)

Example: false
batchSizeinteger(int32)

Number of assets to process in each batch

Example: 100
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/sync:trigger \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dryRun": false,
    "batchSize": 100
  }'

Responses

A successful response.

Bodyapplication/json
resultobject(SyncResult contains the result of a sync operation)
Response
application/json
{
  "result": {
    "importId": "550e8400-e29b-41d4-a716-446655440000",
    "totalProcessed": 1500,
    "newAssets": 50,
    "updatedAssets": 100,
    "failedAssets": 5,
    "conflicts": [ … ],
    "startedAt": "2024-08-08T10:00:00.000Z",
    "completedAt": "2024-08-08T10:15:00.000Z"
  }
}

Transactions - Sweep

Operations

Sweep Instances

Operations