Skip to content
ClonePips

Reference · API

API overview

Every surface reaches the platform through one tenant-scoped gateway. This reference outlines the shape of that surface: scopes, endpoint groups, webhooks and limits.

  • Tenant scope on every request
  • Endpoint groups by resource
  • Webhook events with replay from the log

One gateway, tenant-scoped

There is a single entry point for integrations. Every request carries a tenant scope, and authorisation is per surface, so an integration entitled to reporting is not thereby entitled to move capital.

A single gateway is what makes a broker front-end possible without venue-specific knowledge. The integration talks to platform concepts; the venue hangs off an adapter far below.

Endpoint groups

Endpoints are grouped by the resource they act on, so the surface follows the domain model rather than the screens that happen to use it.

  • Accounts — snapshots, balances and streams
  • Strategies — listings, disclosure and review state
  • Allocations — portfolios, subscriptions, scaling and rebalancing
  • Risk — configuration, evaluation records and operator actions
  • Reporting — snapshots, drawdown and standardised metrics

Webhooks and replay

Order, allocation and risk events are deliverable as webhooks. Because the underlying log is immutable, a webhook can be replayed rather than lost — an integration that misses an event can catch up rather than guess.

Rate limits stated, not guessed

Limits are declared per surface in the reference rather than discovered at integration time. An integration should be able to read its budget, not infer it from responses.

Availability in this build

The gateway and its webhooks are in development; no endpoint is served in this build. This reference describes the intended surface so it can be reviewed before it exists, and it will be replaced by generated documentation when the gateway ships.

Notices

Risk warning

Trading foreign exchange, CFDs and leveraged instruments on margin carries a high level of risk and may not be suitable for all investors.

No advice

Information on this site is provided for general information only and does not constitute investment advice or a recommendation.

Next

See the API capability

The ClonePips API product page describes the gateway surface as a capability area of the platform.