Solana Developer Platform API
Public OpenAPI spec generated from supported API schemas and routes. API versioning is path-based: /v1 is the current contract, and breaking changes are…
Finance & banking#cryptocurrency
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Public OpenAPI spec generated from supported API schemas and routes. API versioning is path-based: /v1 is the current contract, and breaking changes are introduced under a new path major (for example /v2). The OpenAPI info.version tracks spec/document revision for the current path contract.
Endpoints 50
Health
- GETHealth check
/healthReturns service health and build metadata. - GETReadiness check
/health/readyPerforms readiness checks for downstream dependencies.
Wallets
- GETList wallets
/v1/walletsLists active wallets under active Config and Connection owners, oldest first. Provider narrows the list to one custody provider. - POSTCreate wallet
/v1/walletsProvisions a new wallet under exactly one provider account: the project's Managed config for provider, or the Custody Connection named by connectionId. A body… - DELETEDelete wallet
/v1/walletsDeletes the wallet from its exact owning custody target when that Provider supports wallet deletion. Provider, when supplied, is a consistency assertion. - GETList wallet signing configs
/v1/wallets/configsReturns the active Config-owned wallet signing configurations for the requested scope, one per provider. - GETAggregate wallet balances
/v1/wallets/aggregateAggregates tracked balances for active wallets under the same owner-aware inclusion rules as the wallet list, without exposing one aggregate-level owner or… - GETGet wallet public key
/v1/wallets/public-key?walletId=privy_wallet_123Returns the persisted public key for an exact active walletId. walletId is required (400 without it); an API key with selected wallets gets 404 for a wallet… - POSTCheck signer via simulated memo transaction
/v1/wallets/signer-checkSigns a server-authored memo message with the named wallet, verifies the signature, and simulates the transaction. Nothing is broadcast and no sponsorship is… - GETGet wallet by ID
/v1/wallets/:walletIdReturns active wallet metadata, exact Config or Connection ownership, runtime execution admission, Provider, public key, and by default the current SOL… - PATCHUpdate wallet
/v1/wallets/:walletIdUpdates the display label of an active wallet under its exact Config or Connection owner.
Projects
- GETList projects
/v1/projectsLists projects in the organization. - GETGet project
/v1/projects/:projectIdGets project details. - GETGet project provider availability
/v1/projects/:projectId/provider-availabilityLists every provider this deployment's release channel publishes, with whether this project can use it, counting the deployment's provider credentials for the… - GETList project integrations
/v1/integrationsLists the project's integrations and how each reaches the project. A provider is listed only when the project can use it, decided by the same rule that admits…
Payments
- GETGet wallet balances
/v1/payments/wallets/:walletId/balancesRetrieves balances for a custody wallet. If any SOL or SPL balance read fails, returns 503 instead of partial or zero balances. Optional minimumSlot requires… - GETList transfers
/v1/payments/transfersLists persisted payment transfers for the authenticated scope. Set custodyWalletId to select one exact SDP wallet; observed address history is opt-in with… - POSTExecute transfer (custody)
/v1/payments/transfersExecutes an on-chain transfer using the exact SDP Wallet ID (id from /v1/wallets) and server-side custody signing. Requires an Idempotency-Key: a retry with… - GETGet transfer
/v1/payments/transfers/:transferIdRetrieves details for a specific transfer. - POSTEstimate transfer batch
/v1/payments/transfer-batches/estimateValidates an exact-wallet transfer batch request and estimates transaction chunking and fees. warnings lists what would make the batch fail: a native SOL… - GETList transfer batches
/v1/payments/transfer-batchesLists transfer batches for the authenticated organization or project scope. - POSTCreate transfer batch
/v1/payments/transfer-batchesExecutes an outbound transfer batch from one exact SDP Wallet ID, chunks recipients into Solana transactions, and returns the batch, recipient, and transfer… - POSTRetry a transfer batch's failed recipients
/v1/payments/transfer-batches/:batchId/retrySends the batch's failed recipients again, from the same source wallet, and no other recipient. A failed recipient was not paid: its transaction never reached… - GETGet transfer batch
/v1/payments/transfer-batches/:batchIdRetrieves a transfer batch with recipient rows and chunk transfer summaries. - GETList recurring payments
/v1/payments/recurring-paymentsLists SDP-custody outbound recurring payments for the authenticated organization or project scope. - POSTCreate recurring payment
/v1/payments/recurring-paymentsCreates an SDP-custody outbound recurring payment intent from a custody wallet to a counterparty crypto-wallet account. This stores backend state only;… - GETGet recurring payment
/v1/payments/recurring-payments/:idRetrieves an SDP-custody outbound recurring payment record. - PATCHUpdate recurring payment
/v1/payments/recurring-payments/:idUpdates an SDP-custody recurring payment. Pending records are updated directly. Active metadata and due-date edits are applied in place, while active term,… - POSTActivate recurring payment
/v1/payments/recurring-payments/:id/activateActivates a pending SDP-custody recurring payment by creating the Solana subscriptions plan, authorizing the subscription, and storing the resulting on-chain… - POSTCancel recurring payment
/v1/payments/recurring-payments/:id/cancelPermanently stops an active or paused SDP-custody recurring payment by submitting the Solana subscriptions immediate cancellation, which ends its on-chain… - GETList payment requests
/v1/payments/requestsLists the caller's project's payment requests, newest first. Requires payment_requests.read. An open request past its expiresAt reads as expired. Records… - POSTCreate payment request
/v1/payments/requestsCreates a payment request: an amount of one token for a payer to send to a custody wallet in the caller's project, through the request's hosted payment link.… - GETGet payment request
/v1/payments/requests/:paymentRequestIdRetrieves one payment request in the caller's project; another project's request returns 404. Requires payment_requests.read. An open request past its… - GETGet payment request link
/v1/payments/requests/:paymentRequestId/linkReturns the token behind a payment request's hosted payment link, /pay/{publicToken}. Anyone holding it can build the request's fee-sponsored payment… - POSTCancel payment request
/v1/payments/requests/:paymentRequestId/cancelCancels an open payment request, so its payment link stops building and sponsoring transactions. Requires payment_requests.manage. Canceling a request that is… - POSTCollect recurring payment
/v1/payments/recurring-payments/:id/collectManually starts a due active SDP-custody recurring payment collection, creating a linked payment transfer and collection attempt. When admitting a new… - POSTResume recurring payment
/v1/payments/recurring-payments/:id/resumeResumes a paused SDP-custody recurring payment. SDP pauses a recurring payment when a due period fails 5 times, at once when the custody provider's policy… - GETList recurring payment collection attempts
/v1/payments/recurring-payments/:id/collection-attemptsLists every collection attempt a recurring payment has made over its whole history, newest first: its current subscription and every subscription an edit… - GETList transactions
/v1/transactionsLists the project's transactions across SDP modules with stable cursor pagination. Requires transactions.read. Every row also needs the read action of the…
Counterparties
- GETGet counterparty field options
/v1/counterparties/metadataReturns the enum option sets and country list needed to build a counterparty form. - GETList counterparties
/v1/counterpartiesLists counterparties for the authenticated organization. - POSTCreate counterparty
/v1/counterpartiesCreates a counterparty. If externalId is provided, it must be unique within the organization. - GETGet counterparty
/v1/counterparties/:counterpartyIdGets counterparty details by id. - DELETEArchive counterparty
/v1/counterparties/:counterpartyIdArchives a counterparty and its active accounts and provider links atomically. Archived counterparties are hidden from default lists. New transfers and… - PATCHUpdate counterparty
/v1/counterparties/:counterpartyIdUpdates counterparty attributes. At least one field must be provided. Use null on externalId to clear it. - GETList counterparty accounts
/v1/counterparties/:counterpartyId/accountsLists payment accounts for a counterparty. Crypto-wallet accounts can be used by payment flows that send funds to a counterparty wallet. - POSTCreate counterparty account
/v1/counterparties/:counterpartyId/accountsCreates a payment account for a counterparty. For accountKind "crypto_wallet", details.network must be "solana" and details.address must be a Solana wallet… - GETGet counterparty account
/v1/counterparties/:counterpartyId/accounts/:counterpartyAccountIdGets a counterparty payment account by id. - DELETEArchive counterparty account
/v1/counterparties/:counterpartyId/accounts/:counterpartyAccountIdArchives a counterparty payment account. Archived accounts are hidden from default lists. - PATCHUpdate counterparty account
/v1/counterparties/:counterpartyId/accounts/:counterpartyAccountIdUpdates a counterparty payment account. At least one field must be provided. Changing details to an address already on another of the counterparty's active…
API details
- Base URL
http://localhost:8787https://api.solana.com- Authentication
- A bearer token in the Authorization header
- Operations
- 50 operations on 36 pathsGET 28POST 15PATCH 4DELETE 3
- Main resources
- Payments 24Counterparties 11Wallets 9Projects 4Health 2
- Response formats
application/json- Description format
- OpenAPI 3.0.3, API version
0.1.0 - Links
- OpenAPI document
- Listed from
- Solana's published OpenAPI description
How to test the Solana Developer Platform API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Solana Developer Platform API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Health check” (GET /health), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Solana Developer Platform API?
Public OpenAPI spec generated from supported API schemas and routes. API versioning is path-based: /v1 is the current contract, and breaking changes are… It is listed under Finance & banking and has 50 endpoints.
Who publishes the Solana Developer Platform API?
It is listed from Solana's public API description (an OpenAPI document), not published by Solana on Swastik Codes. Anyone who controls solana.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Solana Developer Platform API?
Its description lists 2 base URLs: http://localhost:8787, https://api.solana.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Solana Developer Platform API?
With A bearer token in the Authorization header.
How many endpoints does the Solana Developer Platform API have?
50 operations on 36 paths (28 GET, 15 POST, 4 PATCH, 3 DELETE). The largest groups are Payments, Counterparties, Wallets, Projects.
Is forking the Solana Developer Platform API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.