Create an account.

POST

/api/accounts

const url = 'https://api.tradr.cloud/api/accounts';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"brokerageId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","currency":"example","name":"example","startingBalance":"example","timezone":"America/New_York"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.tradr.cloud/api/accounts \
  --header 'Content-Type: application/json' \
  --data '{ "brokerageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "currency": "example", "name": "example", "startingBalance": "example", "timezone": "America/New_York" }'

Authed. Creates a trading account for the current user. When feature gating is enabled and the user is a non-admin Free user at the L1 account cap, the create is refused with 403 TIER_LIMIT_ACCOUNTS (plan-tiers REQ-6.1) — admins and gating-off deployments pass through unchanged.

Request Body^required

application/json

object

brokerageId

string format: uuid

nullable

currency

required

string

>= 3 characters <= 3 characters

name

required

string

>= 1 characters

startingBalance

string

timezone

IANA zone name (canonical spelling, e.g. America/New_York, Etc/UTC). Defines the account’s trading day. Omitted defaults to America/New_York; an unknown zone is a 400.

string

Example

America/New_York

Responses

201

The created account.

400

Validation error.

403

TIER_LIMIT_ACCOUNTS (account cap reached on the current plan) or FORBIDDEN (cross-user brokerage).

409

Duplicate account name.

Create an account.

Request Bodyrequired

Example

Responses

201

400

403

409

Request Body^required