NDAX Accounts API
The Accounts API from NDAX — 9 operation(s) for accounts.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/ndax:ndax-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Ndax Pro Accounts API
version: '2026-10-13'
description: 'Generated by API Evangelist from the Ndax Pro API reference at https://apidoc.ndax.io (Slate). Ndax is built on AlphaPoint: every function is documented as a JSON payload sent inside a message frame {m,i,n,o} over wss://api.ndax.io/WSGateway/. Public functions also answer over HTTP at https://api.ndax.io:8443/AP/{FunctionName} (Ping, GetInstruments and GetProducts verified live 2026-10-13). Each path here is a documented function name; this is NOT a provider-published contract.'
contact:
url: https://ndax.io/support
termsOfService: https://ndax.io/en/legal/account-agreements
x-generated-from: documentation
x-provenance: generated
x-authored-by: API Evangelist
x-generated: '2026-10-13'
x-generator: deterministic parse of https://apidoc.ndax.io section headings, Category/Permissions/CallType lines and request/response examples (no model)
servers:
- url: https://api.ndax.io:8443/AP
description: Ndax AlphaPoint HTTP gateway
security:
- apiKeySignature: []
tags:
- name: Accounts
paths:
/GenerateTradeActivityReport:
post:
operationId: generateTradeActivityReport
summary: Generate Trade Activity Report
description: Creates an immediate report on historical trade activity on a specific Order Management System for a list of accounts during a specified time interval. A user with Trading permission can only generate reports for accounts with which he is associated; a user with Operator permission can generate reports for accounts associated with others. The Trade Activity Report is delivered as a comma-separated (CSV) file. For specific CSV formatting information, see the APEX Extract CSV Data Dictionary, available from AlphaPoint. Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#generatetradeactivityreport
x-websocket-function: GenerateTradeActivityReport
requestBody:
required: false
content:
application/json:
schema:
type: object
example:
accountIdList:
- 0
omsId: 0
startTime: '0001-01-01T05:00:00Z'
endTime: '0001-01-01T05:00:00Z'
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
example:
RequestingUser: 1
OMSId: 1
reportFlavor:
Options:
- TradeActivity
- Transaction
- Treasury
createTime: '2018-08-17T15:34:20Z'
initialRunTime: '2018-08-17T15:34:20Z'
intervalStartTime: '2019-04-10T04:00:00Z'
intervalEndTime: '2020-04-10T04:00:00Z'
RequestStatus:
Options:
- Submitted
- Validating
- Scheduled
- InProgress
- Completed
- Aborting
- Aborted
- UserCancelled
- SysRetired
- UserCancelledPending
ReportFrequency:
Options:
- onDemand
- Hourly
- Daily
- Weekly
- Monthly
- Annually
intervalDuration: 316224000000000
RequestId: Moy/IpfPA0SLUHNYt54q4w==
lastInstanceId: AAAAAAAAAAAAAAAAAAAAAA==
accountIds:
- 1
x-requires-session: true
/GenerateTransactionActivityReport:
post:
operationId: generateTransactionActivityReport
summary: Generate Transaction Activity Report
description: Generates an immediate report on account transaction activity for a list of accounts under a single Order Management System during a specified time. A user with Trading permission can only generate reports for accounts with which he is associated; a user with Operator permission can generate reports for accounts associated with others. There can be multiple users associated with an account. The Transaction Activity Report is delivered as a comma-separated (CSV) file. For specific CSV formatting information, see the APEX Extract CSV Data Dictionary, available from AlphaPoint. Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#generatetransactionactivityreport
x-websocket-function: GenerateTransactionActivityReport
requestBody:
required: false
content:
application/json:
schema:
type: object
example:
accountIdList:
- 0
omsId: 0
startTime: '0001-01-01T05:00:00Z'
endTime: '0001-01-01T05:00:00Z'
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
example:
RequestingUser: 1
OMSId: 1
reportFlavor:
Options:
- TradeActivity
- Transaction
- Treasury
createTime: '2018-08-17T15:46:07Z'
initialRunTime: '2018-08-17T15:46:07Z'
intervalStartTime: '2019-04-10T04:00:00Z'
intervalEndTime: '2020-04-10T04:00:00Z'
RequestStatus:
Options:
- Submitted
- Validating
- Scheduled
- InProgress
- Completed
- Aborting
- Aborted
- UserCancelled
- SysRetired
- UserCancelledPending
ReportFrequency:
Options:
- onDemand
- Hourly
- Daily
- Weekly
- Monthly
- Annually
intervalDuration: 316224000000000
RequestId: +QgyhnEFqEazyZ46Q902MA==
lastInstanceId: AAAAAAAAAAAAAAAAAAAAAA==
accountIds:
- 1
x-requires-session: true
/GenerateTreasuryActivityReport:
post:
operationId: generateTreasuryActivityReport
summary: Generate Treasury Activity Report
description: Generates an immediate report on all company treasury activities related to the trading venue — those withdrawals, transfers, and funds movements that are unrelated to specific trades — over a specified period. A user with Trading permission can only generate reports for accounts with which he is associated; a user with Operator permission can generate reports for accounts associated with others. There can be multiple users associated with an account. The Trade Activity Report is delivered as a comma-separated (CSV) file. For specific CSV formatting information, see the APEX Extract CSV Data D Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#generatetreasuryactivityreport
x-websocket-function: GenerateTreasuryActivityReport
requestBody:
required: false
content:
application/json:
schema:
type: object
example:
accountIdList:
- 0
omsId: 0
startTime: '0001-01-01T05:00:00Z'
endTime: '0001-01-01T05:00:00Z'
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
example:
RequestingUser: 1
OMSId: 1
reportFlavor:
Options:
- TradeActivity
- Transaction
- Treasury
createTime: '2018-08-17T15:38:59Z'
initialRunTime: '2018-08-17T15:38:59Z'
intervalStartTime: '2019-04-10T04:00:00Z'
intervalEndTime: '2020-04-10T04:00:00Z'
RequestStatus:
Options:
- Submitted
- Validating
- Scheduled
- InProgress
- Completed
- Aborting
- Aborted
- UserCancelled
- SysRetired
- UserCancelledPending
ReportFrequency:
Options:
- onDemand
- Hourly
- Daily
- Weekly
- Monthly
- Annually
intervalDuration: 316224000000000
RequestId: adduAIKE6Ee0eGxFM+ydsg==
lastInstanceId: AAAAAAAAAAAAAAAAAAAAAA==
accountIds:
- 1
x-requires-session: true
/GetAccountInfo:
post:
operationId: getAccountInfo
summary: Get Account Info
description: Returns detailed information about one specific account and existing on a specific Order Management System. Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading, AccountReadOnly
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#getaccountinfo
x-websocket-function: GetAccountInfo
requestBody:
required: false
content:
application/json:
schema:
type: object
example:
omsId: 0
accountId: 0
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
x-requires-session: true
/GetAccountPositions:
post:
operationId: getAccountPositions
summary: Get Account Positions
description: Retrieves a list of positions (balances) for a specific user account running under a specific Order Management System. The trading day runs from UTC Midnight to UTC Midnight. Users with Trading or AccountReadOnly permission must specify an account ID with which they're associated on the Order Management System. Users with Operator permission can specify other accounts. Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading, AccountReadOnly
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#getaccountpositions
x-websocket-function: GetAccountPositions
requestBody:
required: false
content:
application/json:
schema:
type: object
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
example:
- omsId: 1
accountId: 4
productSymbol: BTC
productId: 1
amount: 0.0
hold: 0.0
pendingDeposits: 0.0
pendingWithdraws: 0.0
totalDayDeposits: 0.0
totalMonthDeposits: 0.0
totalYearDeposits: 0.0
totalYearDepositNotional: 0.0
totalDayWithdraws: 0.0
totalMonthWithdraws: 0.0
totalYearWithdraws: 0.0
totalYearWithdrawNotional: 0.0
- omsId: 1
accountId: 4
productSymbol: USD
productId: 2
amount: 0.0
hold: 0.0
pendingDeposits: 0.0
pendingWithdraws: 0.0
totalDayDeposits: 0.0
totalMonthDeposits: 0.0
totalYearDeposits: 0.0
totalYearDepositNotional: 0.0
totalDayWithdraws: 0.0
totalMonthWithdraws: 0.0
totalYearWithdraws: 0.0
totalYearWithdrawNotional: 0.0
x-requires-session: true
/GetTreasuryProductsForAccount:
post:
operationId: getTreasuryProductsForAccount
summary: Get Treasury Products For Account
description: Returns a list of product symbols (BTC, USD, etc.) upon which the account named by AccountId is allowed to execute treasury operations. Users with Trading, Withdraw, and Deposit permission must be associated with the account named by AccountId. Users with Operator permission can request the list of treasury products for any account. Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading, Withdraw, Deposit
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#gettreasuryproductsforaccount
x-websocket-function: GetTreasuryProductsForAccount
requestBody:
required: false
content:
application/json:
schema:
type: object
example:
AccountId: 1
OMSId: 1
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
x-requires-session: true
/ScheduleTradeActivityReport:
post:
operationId: scheduleTradeActivityReport
summary: Schedule Trade Activity Report
description: Schedules a series of trade activity reports to run for a list of accounts on a single Order Management System, starting at a specific date/time, and covering a specific time duration. The reports will run periodically until canceled. Users with Trading permission can schedule reports for accounts with which they are associated; users with Operator permissions can schedule reports for any accounts. Trade Activity Reports are delivered in comma-separated-value (CSV) format. For specific CSV formatting information, see the APEX Extract CSV Data Dictionary, available from AlphaPoint. Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#scheduletradeactivityreport
x-websocket-function: ScheduleTradeActivityReport
requestBody:
required: false
content:
application/json:
schema:
type: object
example:
frequency:
Options:
- OnDemand
- Hourly
- Daily
- Weekly
- Monthly
- Annual
accountIdList:
- 1
omsId: 1
beginTime: '2018-08-10T04:00:00.000Z'
intervalDuration: 10
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
example:
RequestingUser: 1
OMSId: 1
reportFlavor:
Options:
- TradeActivity
- Transaction
- Treasury
createTime: '2018-08-17T17:57:51Z'
initialRunTime: '2018-08-10T04:00:00Z'
intervalStartTime: '2018-08-10T04:00:00Z'
intervalEndTime: '2018-08-10T05:00:00Z'
RequestStatus:
Options:
- Submitted
- Validating
- Scheduled
- InProgress
- Completed
- Aborting
- Aborted
- UserCancelled
- SysRetired
- UserCancelledPending
ReportFrequency:
Options:
- onDemand
- Hourly
- Daily
- Weekly
- Monthly
- Annually
intervalDuration: 36000000000
RequestId: mGzjUfylGEmqgJIxu651aQ==
lastInstanceId: AAAAAAAAAAAAAAAAAAAAAA==
accountIds:
- 1
x-requires-session: true
/ScheduleTransactionActivityReport:
post:
operationId: scheduleTransactionActivityReport
summary: Schedule Transaction Activity Report
description: Schedules a series of transaction activity reports for a list of accounts on a single Order Management System, starting at a specific date/time, and covering a specific time interval (90 days, for example). The reports run periodically until canceled. Users with Trading permission can schedule transaction activity reports only for accounts with which they are associated; users with Operator permission can schedule transaction activity reports for any account. Transaction Activity Reports are delivered in comma-separated-value (CSV) format. For specific CSV formatting information, see the APEX Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#scheduletransactionactivityreport
x-websocket-function: ScheduleTransactionActivityReport
requestBody:
required: false
content:
application/json:
schema:
type: object
example:
frequency: 0
accountIdList:
- 1
omsId: 1
beginTime: '2018-08-10T04:00:00.000Z'
intervalDuration: 10
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
example:
RequestingUser: 1
OMSId: 1
reportFlavor: Transaction
createTime: '2018-08-17T18:02:23Z'
initialRunTime: '2018-08-10T04:00:00Z'
intervalStartTime: '2018-08-10T04:00:00Z'
intervalEndTime: '2018-08-10T05:00:00Z'
RequestStatus: Submitted
ReportFrequency: Hourly
intervalDuration: 36000000000
RequestId: I2nCtvyY8UuHsoSyrLe2QA==
lastInstanceId: AAAAAAAAAAAAAAAAAAAAAA==
accountIds:
- 1
x-requires-session: true
/ScheduleTreasuryActivityReport:
post:
operationId: scheduleTreasuryActivityReport
summary: Schedule Treasury Activity Report
description: Schedules a series of treasury activity reports for a list of accounts on a single Order Management System, starting at a specific date/time, and covering a specific time interval. Treasury activities are non-trading transactions such as deposits and withdrawals. The reports runs periodically until canceled. A user with Trading permission may schedule reports only for accounts with which he is associated; a user with Operator permission may schedule reports for any accounts. The Treasury Activity Report itself is delivered as a comma-separated-value (CSV) file. For specific CSV formatting info Requires an authenticated session; the documentation states authentication happens over the WebSocket gateway (wss://api.ndax.io/WSGateway/).
tags:
- Accounts
x-category: User
x-permissions: Operator, Trading
x-call-type: Synchronous
x-docs-url: https://apidoc.ndax.io/#scheduletreasuryactivityreport
x-websocket-function: ScheduleTreasuryActivityReport
requestBody:
required: false
content:
application/json:
schema:
type: object
example:
frequency: 0
accountIdList:
- 1
omsId: 1
beginTime: '2018-08-10T04:00:00.000Z'
intervalDuration: 10
responses:
'200':
description: Function reply payload.
content:
application/json:
schema: {}
example:
RequestingUser: 1
OMSId: 1
reportFlavor: Treasury
createTime: '2018-08-17T18:02:03Z'
initialRunTime: '2018-08-10T04:00:00Z'
intervalStartTime: '2018-08-10T04:00:00Z'
intervalEndTime: '2018-08-10T05:00:00Z'
RequestStatus: Submitted
ReportFrequency: Hourly
intervalDuration: 36000000000
RequestId: xbsVgAuUcEyTFgf/gpWB2A==
lastInstanceId: AAAAAAAAAAAAAAAAAAAAAA==
accountIds:
- 1
x-requires-session: true
components:
securitySchemes:
apiKeySignature:
type: apiKey
in: header
name: Authorization
x-source: https://apidoc.ndax.io/#authenticateuser