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. |
integration_id | uuid | null | The connection that owns a provider identity. Null for records without a current integration. |
external_id | string | null | Your id, or the provider id for an imported trader. |
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>
Saved CRM records only. Paginated with page and limit, plus filters such as search.
GET/v1/traders/searchtraders:read
Returns TraderSearchResponse
| Field | Type | Description |
|---|---|---|
search | string | Optional query, up to 120 characters without control characters. Provider calls start at 2 characters; shorter or empty queries return local records only. |
limit | integer | Optional query. Default 8, clamped to 1 through 20 per source. |
Returns saved CRM matches in local and ephemeral provider suggestions in providers. Each active integration is identified byintegration_id and provider_name. Do not identify a suggestion by external ID alone across several integrations. No search result is imported.
{
"local": [],
"providers": [{
"integration_id": "00000000-0000-4000-8000-000000000001",
"provider_name": "Own tech",
"source": "custom_api",
"external_id": "cus_18422",
"full_name": "Jane Doe",
"email": "jane@example.com",
"country": "GB"
}],
"errors": []
}Provider failures appear in errors as { integration_id, provider_name, code, message }. Results from the CRM and other available providers remain usable. An unsupported search never falls back to importing or scanning the provider directory.
POST/v1/traders/importtraders:read + traders:write
Returns TraderDetail
| Field | Type | Description |
|---|---|---|
integration_id | uuid | Required. The active integration from the selected search suggestion. |
external_id | string | Required. The exact provider trader ID from the selected suggestion, up to 256 bytes without control characters. |
{
"integration_id": "00000000-0000-4000-8000-000000000001",
"external_id": "cus_18422"
}Fetches the selected trader's exact profile, their accounts, recent trades and optional payouts, then saves the complete scoped result. Own tech uses a 90-day updated_since window; Axcera retrieves trades closed in the last 90 days and all current open positions. The returned Rubi id can be used to create the interview. Selecting that provider trader again refreshes their data.
Missing profiles, unsupported filters and records outside the selected trader or account scope fail the retrieval. No partial snapshot is saved. Previously imported data remains available; connecting a provider does not schedule a backfill or periodic global polling.
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. |
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." }.