@primevault/js-api-sdk.
Base URL
Start here
Authentication
Credentials, request signing, headers, key safety, and auth troubleshooting.
Filtering and Pagination
List filters,
limit, cursor pagination, and SDK iteration.Status Codes
HTTP status classes, SDK error types, and retry guidance.
Custom Error Codes
Error envelope, handling order, and endpoint-specific codes.
Endpoint reference
Endpoints
Operations for assets and chains, vaults, transactions, contacts, and bank accounts.
Data Models
Shared request and response objects.
Shared request conventions
JSON example convention
- POST and PUT examples show the actual request body.
- GET examples show path and query parameters as JSON for documentation only; they’re encoded in the URL, not sent as a body.
- Responses are representative and may omit optional fields.
Integration checklist
Complete these before going to production.1
Create a dedicated API user
Keep its private key out of source control. See Setting Up an API User.
2
Verify authentication
Call a read-only endpoint with the official SDK.
3
Implement pagination
Use cursor traversal on every list endpoint you consume.
4
Handle errors in order
Typed HTTP errors first, then custom error codes.
5
Retry safely
When retrying a timed-out transaction creation, reuse a stable client reference where supported.
6
Log without secrets
Log request context, HTTP status, and error code — never credentials or sensitive payloads.