Traders API
A trader is a CRM record: identity, trading accounts, trades, payouts, notes and every interview they took.
The trader object#
| Field | Type | Description |
|---|---|---|
id | uuid | Rubi identifier. |
external_id | string | null | Your id, or the provider id for synced traders. |
source | axcera | custom_api | manual | api | Where the record comes from. |
full_name, email, country | string | Identity. country is ISO 3166-1 alpha-2. |
status | active | watchlist | blocked | archived | Your team's status. |
tags | string[] | Free tags. |
risk_level | low | medium | high | null | Latest risk from interviews. |
accounts_count, interviews_count | number | Counters. |
last_interview_at, last_decision | timestamp, Decision | Latest interview outcome. |
registered_at, last_synced_at, created_at | timestamp | Lifecycle. |
The detail adds first_name, last_name, phone, metadata, accounts, payouts, notes, interviews and stats (trades_count, win_rate, net_profit, total_payouts).
Endpoints#
GET/v1/traderstraders:read
Returns Page<TraderListItem>
Paginated with page and limit, plus filters such as search.
GET/v1/traders/{id}traders:read
Returns TraderDetail
POST/v1/traderstraders:write
Returns TraderDetail
| Field | Type | Description |
|---|---|---|
full_name | string | Required. |
email, external_id, country, phone | string | null | Optional identity fields. |
tags | string[] | Optional. |
bash
curl https://api.rubikyt.com/v1/traders \
-H "Authorization: Bearer $RUBI_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "full_name": "Jane Doe", "email": "jane@example.com", "external_id": "cus_18422", "tags": ["vip"] }'PATCH/v1/traders/{id}traders:write
Returns TraderDetail
Any creation field, plus status.
GET/v1/traders/{id}/tradestraders:read
Returns Page<Trade>
| Field | Type | Description |
|---|---|---|
id | number | Rubi trade id. |
account_id, external_id | uuid, string | null | Account and ticket. |
symbol, side | string, buy | sell | Instrument and direction. |
lots | number | null | Volume in lots. |
open_time, close_time | timestamp | null | Close is null while open. |
open_price, close_price, profit | number | null | Net profit in account currency. |
is_open | boolean | Open position. |
POST/v1/traders/{id}/notestraders:write
Returns TraderNote
Body { "body": "Called on 23 Sept, confirmed a single device." }.