# Axiym Client Trade API

Product: Client Trade API
API reference version: 0.3.0 (current)
OpenAPI contract: https://docs.axiym.io/openapi/trade-api/0.3.0.yaml
Canonical page: https://docs.axiym.io/trade-api/api-reference/0.3.0

Use the Client Trade API to manage balances and move funds on behalf of clients onboarded through your partnership. The partner access token identifies the partnership, and `clientId` identifies the client that owns each account, address book entry, deposit, conversion, and withdrawal.

Webhook subscriptions are partnership-owned and deliver events for client-owned resources. Use the event `clientId` to route each event to the correct client context.

## Downloads




OpenAPI contract

v0.3.0 · current

Explore the schema or generate a client for your integration.

[


Download OpenAPI](/openapi/trade-api/0.3.0.yaml)




Postman collection

v0.3.0 · current

Import ready-to-use requests and connect to the sandbox.

[


Download collection](/postman/trade-api/axiym_trade_api_v0.3.0.json)

## Environments




Sandbox

[`https://partner-api.sandbox.axiym.io/api/v1`](https://partner-api.sandbox.axiym.io/api/v1)




Production

[`https://partner-api.axiym.io/api/v1`](https://partner-api.axiym.io/api/v1)

## Resources



[Auth](/trade-api/api-reference/0.3.0/auth/oauth/token/post)

OAuth 2.0 client credentials authentication for the partnership.







[Onboarding](/trade-api/api-reference/0.3.0/onboarding/startOnboarding)

Client KYB onboarding applications and their review status.







[Clients](/trade-api/api-reference/0.3.0/clients/listClients)

Client records associated with your partnership. The list includes clients that are onboarding, active, or disabled; only active clients can use Client Trade API operations.







[Accounts](/trade-api/api-reference/0.3.0/accounts/listAccounts)

Axiym accounts and balances owned by the represented client.







[Address Book](/trade-api/api-reference/0.3.0/address-book/listAddressBookEntries)

External bank accounts and wallets owned by the represented client, registered as deposit sources and withdrawal recipients.







[Deposits](/trade-api/api-reference/0.3.0/deposits/getDepositInstructions)

Incoming funds credited to the represented client’s Axiym accounts.







[Conversions](/trade-api/api-reference/0.3.0/conversions/listConversionPairs)

Currency conversions between the represented client’s permitted Axiym accounts.







[Withdrawals](/trade-api/api-reference/0.3.0/withdrawals/listWithdrawals)

Outgoing funds from the represented client’s Axiym accounts.







[Webhook Subscriptions](/trade-api/api-reference/0.3.0/webhook-subscriptions/webhooks/subscriptions/get)

Partnership-owned webhook subscriptions and signing keys.