Skip to content

Open platform

The OhMy.xin open platform exposes part of the platform to external systems over an API: you create an API account and API keys on the website, then call the open endpoints from your own software.

Auth, rate limiting, the shared response and error format, call logging — the platform handles all of that, so you can focus on your own integration.

The shared integration framework ships with two service endpoints:

  • Health check (GET /api/v1/health) — no key needed; confirms the service is reachable.
  • Credential self-check (GET /api/v1/me) — call it with your key to confirm the credential works and see your account and key details.

Two business endpoints are already live on top of it:

  • Strategies list (GET /api/v1/strategies) — publicly visible trading signals, filterable by circle, symbol, side, and time window.
  • Lives list (GET /api/v1/lives) — publicly visible livestreams with their state, viewer count, and replay availability.

More business endpoints will be added to the same framework over time. They inherit the same auth, rate limiting, pagination, and error contract automatically — your integration code needs no extra adaptation for them.

Concept What it means
API account The unit you integrate under; use separate accounts to isolate projects or environments (say, one for production, one for testing). Up to 5 per user by default.
API key The credential you call the API with, attached to an API account and prefixed with omx_live_. The full secret is shown exactly once, at creation; afterwards only a masked fragment. Up to 10 active keys per account by default.
Rate limit 60 requests per minute per API account by default; a fallback per-IP bucket (default 300 per minute) additionally caps all /api/ traffic from one source IP, valid credentials or not.
Call log Every request that enters the gateway’s processing chain — auth failures and throttled calls included — leaves a structured record you can filter by key, time, endpoint, and outcome. Kept for 90 days by default; requests rejected outright by the IP-level bucket leave no record.
Request ID Every response carries a unique request_id; share it with the platform and support can line up the server logs.

The same contract is available in machine-readable form, so code generators and LLM tool-calls can consume it directly: