Skip to content
RUBI

Axcera endpoints

Rubi searches the Axcera Open API and retrieves only the selected customer and their activity. The connector uses the provider's documented search and ownership filters.

See the Axcera setup guide for credentials and the IP allowlist. For a platform you control, implement the Own tech contract.

Request rules#

  • Base URL https://openapi.<tenant>.app.axcera.io. A trailing /v1 is stripped before the paths below are appended.
  • Headers Authorization: Bearer <api key> and Accept: application/json. Rubi never writes to Axcera.
  • List requests use page starting at 1 and a bounded limit, up to 100. Suggestions read only the first search page.
  • All pages in a retrieval retain their customer/account filters. Ownership is checked on the response before any trader data is saved.
  • Retrieval is capped at 100 pages per traversal and 100,000 snapshot records. Repeated records, ignored page limits and cap overruns fail without a partial import.
  • Connection checks do not import samples or schedule a whole-book backfill or periodic polling.
Search fields depend on the provider
The verified Axcera API v1.0.2 contract exposes a generic search parameter. It does not enumerate every indexed field. Name, email and customer-number matching depend on what the tenant indexes. CI is not a separately confirmed search field; if it denotes the customer number, it can match customerNr when indexed. A response field alone does not establish search support. Rubi checks that returned identities match the query and never scans the customer directory as a fallback.

GET/v1/customers

Returns page of matching customers

QueryValue Rubi sends
searchThe user's query, after at least two characters in the interview picker.
page, limitFirst page only; bounded suggestions, default 8.

Suggestions remain ephemeral. Their external ID identifies the customer only within this integration.

FieldTypeDescription
customerIdstringStable provider customer identity. Aliases customer_id and id.
emailstring | nullEmail shown in suggestions and used for targeted account lookup.
firstName, lastNamestring | nullIdentity shown in suggestions. Snake-case aliases are accepted.
customerNrstring | nullCustomer number retained as customer_nr in metadata.
country, phone, kycStatusstring | nullOptional selected-trader profile fields.
createdAt, updatedAttimestamp | nullRegistration and profile update times.

GET/v1/customers/{id}

Returns one customer

Fetches the exact selected customer. The returned identity must match the requested provider ID. A missing customer or mismatched identity fails retrieval; Rubi never falls back to walking the directory. The detail response contains the customer object under data.

GET/v1/prop-accounts

Returns page of selected-customer accounts

The verified contract has a generic search filter, not a dedicated customer ownership parameter. Rubi searches the selected customer's email and validates that every returned account belongs to their customer ID. A missing usable email or an ignored filter fails retrieval. Without an account scope, the fetched account count must match nrOfAccounts when the customer profile provides it.

QueryValue Rubi sends
searchThe exact selected customer email.
page, limitPages from 1, up to 100 records per page.
plan_category_ids, platformsConfigured account scope, when present.
FieldTypeDescription
accountNrstringAccount number used as the Rubi account external ID.
accountIdstringProvider resource ID used by account_ids filters. Distinct from the account number or login.
customer.customerIdstringOwner identity. Must match the selected customer.
login, platform, plan, phase, statusstring | nullAccount identity and lifecycle.
currency, initialBalance, currentBalance, currentEquitystring, number | nullAccount currency and balances.

GET/v1/prop-accounts/{id}

Returns one account

Each selected account is checked against its exact provider resource ID. The data object supplies account details; its identity and customer ownership must match the selected account. Configured scope is checked using rules.planCategoryId and platform.name.

GET/v1/trades/closed

Returns page of selected-account closed trades

QueryValue Rubi sends
customer_idsThe selected customer's provider resource ID.
account_idsThe selected account's provider resource ID, not its account number.
close_time_gteISO 8601 cutoff, 90 days before retrieval.
sort_by, sort_ordercloseDate, desc.
page, limitPages from 1, up to 100 records per page.

This window filters by close time. Rubi does not send Own tech's updated_since here. A trade for another customer or account fails retrieval. Provider account references are mapped back to the selected Rubi account before saving.

FieldTypeDescription
ticketstringStable trade identity within its account.
accountNr / accountIdstringAccount number or resource reference, matched against the selected account.
symbol, sidestringInstrument and buy/sell direction.
lotsnumber | nullPreferred lot size. Raw volume can represent units and must not be interpreted as lots blindly.
openDate, closeDatetimestamp | nullPosition times; the closed-trade window uses closeDate.
openPrice, closePrice, stopLossPrice, takeProfitPricenumber | nullPrices when exposed.
pnl, commission, swapnumber | nullProfit and costs in account currency.

GET/v1/trades/open

Returns page of selected-account open trades

Uses the same customer_ids and account_ids ownership filters, without a close-time cutoff. It retrieves all current open positions for the selected account. Open positions older than 90 days remain relevant to current exposure.

Open positions use sort_by=ticket. If the provider returns inconsistent counts, additional descending and symbol-scoped passes retain the same customer and account filters and combine positions by ticket. No date cutoff is applied.

A successful complete Axcera snapshot replaces the saved open-position set for its selected accounts. This removes stale open tickets when the provider has closed a position under another ticket. No unrelated trader's positions are affected.

GET/v1/payouts

Returns page of selected-customer payouts

QueryValue Rubi sends
customer_idThe selected customer ID. This parameter is singular, unlike trades.
typetrader
plan_category_idsConfigured plan category scope, when present. This endpoint has no platforms filter.
page, limitPages from 1, up to 100 records per page.

Every payout must belong to the selected customer and include an account resource ID. With a platform scope, payouts for accounts outside the selected platform set are omitted after customer ownership is verified. Otherwise an unknown account fails retrieval. This resource is optional: HTTP 404 skips payouts. Other errors fail retrieval without saving a partial snapshot.

Connection checks#

CheckBounded request
AccessGET /v1/prop-accounts?page=1&limit=1 plus configured scope.
Customer sampleGET /v1/customers?page=1&limit=1. The sample is not stored.
Search and identitySearch the sample email with limit=5, then GET /v1/customers/{id}.
AccountsSearch the sample email plus scope with limit=1, checking customer ownership.
Closed and open tradesOne record per endpoint for the first account, with customer_ids and account_ids plus scope.
PayoutsOne record with customer_id, type=trader and plan scope. Optional 404 warns.

Empty resources skip dependent checks; an empty customer directory uses a dummy search. Diagnostics never persist samples or page through the entire directory. Actual retrieval also checks account detail, pagination, scope and date limits before saving any records.

Account scope#

Optional scope
{ "plan_category_ids": ["665f173dc93f9ccd08e12e42"], "platforms": ["MT5"] }

Only plan_category_ids and platforms are accepted scope keys; unknown keys are rejected. Use Axcera string resource IDs and vendor platform names such as MT5 or CTrader. These may differ from normalized platform codes stored in Rubi. Scope is additional to ownership filtering. It never replaces the selected customer or account identity. Every retrieval validates the returned relationships; unsupported filters fail without a global fallback.