API scopes

Scopes limit the operations a Management API key can perform. A key must also have access to the target server.

Scope	Allows
accounts:read	List accounts, read account details, inspect commands, read server configuration, and export history.
accounts:create	Create one account or bulk-create accounts.
accounts:update	Update, enable, disable, archive, or reset passwords for accounts. Also update server configuration.
accounts:connect	Generate broker, account, and one-time auto-login QR codes. See QR account connections.
trades:write	Place a market, limit, or stop order, and modify or cancel a pending order. See Trade and position management.
positions:write	Close a position, close every position on an account, and change stop-loss or take-profit levels.
finance:deposit	Deposit funds into a trading account.
finance:withdraw	Withdraw funds from a trading account.
metrics:read	Read metric snapshots and subscribe to live account metrics.
markets:write	Change an instrument’s terms: the leverage ceiling, the spread and its minimum, and whether the instrument trades. See Instrument terms.
credits:read	Read the organization’s API credit balance.
webhooks:manage	Reserved for webhook management. No public Management API endpoint currently uses this scope.

Server access

Every key has one of two server access modes:

• all allows the key to act on every server owned by the organization.
• selected allows the key to act only on server IDs chosen when the key is created.

A correct scope does not override a server restriction. Koneth returns 403 if the key cannot access the requested server.

Recommended key profiles

Integration	Suggested scopes
Read-only reporting	accounts:read, metrics:read, credits:read
Client onboarding	accounts:read, accounts:create
QR account onboarding	accounts:read, accounts:connect
Account operations	accounts:read, accounts:update
Funding service	accounts:read, finance:deposit, finance:withdraw
Risk and exposure control	accounts:read, metrics:read, positions:write
Scheduled margin and spreads	markets:write
Full trading integration	accounts:read, accounts:create, trades:write, positions:write

Warning

A key with finance scopes can change trading account balances. Restrict it to the required servers and keep it isolated from general application code.

trades:write and positions:write move money too. A key with these scopes can open and close trades on any server it can access, so treat it like the funding scopes: restrict it to the servers you intend to trade and keep it out of client-side code.