Skip to content
API status
API reference

Overview

Koneth Management API 1.0.0

Section titled “Koneth Management API 1.0.0”

Use the Koneth Management API to manage trading accounts, account funds, server configuration, metrics, commands, and API credits from your backend.

Keep management keys on a trusted server. Do not call this API directly from browser or mobile applications.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/api/v1/management/credits/balance
GET
/api/v1/management/servers/{serverId}/configuration
PATCH
/api/v1/management/servers/{serverId}/configuration
POST
/api/v1/management/servers/{serverId}/capacity/sync
GET
/api/v1/management/servers/{serverId}/accounts
POST
/api/v1/management/servers/{serverId}/accounts
POST
/api/v1/management/servers/{serverId}/accounts/bulk
GET
/api/v1/management/servers/{serverId}/accounts/{accountNumber}
PATCH
/api/v1/management/servers/{serverId}/accounts/{accountNumber}
GET
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/transactions
GET
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/orders
GET
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/positions
GET
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/deals
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/enable
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/disable
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/archive
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/password-reset
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/investor-password-reset
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/exports/history
GET
/api/v1/management/servers/{serverId}/account-credentials
POST
/api/v1/management/servers/{serverId}/accounts/reconcile
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/finance/deposits
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/finance/withdrawals
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/trades
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/orders/{orderId}/cancel
PATCH
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/orders/{orderId}
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/positions/close-all
POST
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/positions/{positionId}/close
PATCH
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/positions/{positionId}
GET
/api/v1/management/servers/{serverId}/accounts/{accountNumber}/logins
GET
/api/v1/management/servers/{serverId}/logins
POST
/api/v1/management/servers/{serverId}/connection-qr
POST
/api/v1/management/servers/{serverId}/connection-qr/{connectionId}/revoke
GET
/api/v1/management/commands/{commandId}
GET
/api/v1/management/servers/{serverId}/commands
POST
/api/v1/management/servers/{serverId}/commands/drain
GET
/api/v1/management/servers/{serverId}/account-metrics
GET
/api/v1/management/servers/{serverId}/runtime/events
POST
/api/v1/management/servers/{serverId}/runtime/sync
GET
/api/v1/organizations/{organizationId}/webhooks
POST
/api/v1/organizations/{organizationId}/webhooks
DELETE
/api/v1/organizations/{organizationId}/webhooks/{webhookId}
PATCH
/api/v1/organizations/{organizationId}/webhooks/{webhookId}
POST
/api/v1/organizations/{organizationId}/webhooks/{webhookId}/verify
POST
/api/v1/organizations/{organizationId}/webhooks/{webhookId}/disable
POST
/api/v1/organizations/{organizationId}/webhooks/{webhookId}/rotate-secret
GET
/api/v1/organizations/{organizationId}/webhook-deliveries
POST
/api/v1/organizations/{organizationId}/webhook-deliveries/{deliveryId}/redeliver
PATCH
/api/v1/management/servers/{serverId}/instruments/{symbol}
PATCH
/api/v1/management/servers/{serverId}/instrument-categories/{category}

Authentication

Section titled “Authentication”

managementKey

Section titled “managementKey”

Enter Management kapi.<key-id>.<secret>.

Security scheme type: apiKey

Header parameter name: Authorization

consoleSession

Section titled “consoleSession”

Access token of the signed-in Koneth Console user. The user must belong to the organization as an Owner or Finance member. This is not a management key, and the Console API is not meant to be called from a backend service.

Security scheme type: http