Skip to main content

Search for Account

API URL: POST https://gateway-api-demo.s2f.projectx.com/api/Account/search

API Reference: /api/account/search

Description


Search for accounts.

Parameters


NameTypeDescriptionRequiredNullable
onlyActiveAccountsbooleanWhether to filter only active accounts.Requiredfalse

Example Usage


Example Request

curl -X 'POST' \
'https://gateway-api-demo.s2f.projectx.com/api/Account/search' \
-H 'accept: text/plain' \
-H 'Content-Type: application/json' \
-d '{
"onlyActiveAccounts": true
}'

Example Response

{
"accounts": [
{
"id": 1,
"name": "TEST_ACCOUNT_1",
"balance": 50000,
"canTrade": true,
"isVisible": true
}
],
"success": true,
"errorCode": 0,
"errorMessage": null
}