Skip to main content
PATCH
Update or pause own price alert

Authorizations

Authorization
string
header
required

An OceanX API key, created in the app under Settings → Developer API. Send it as Authorization: Bearer ox_live_…. Required scopes are operation-specific: market reads use md.read, tracker uses tracker.read, copy reads use copy.read, and alert operations use alerts.read or alerts.write. New scopes require explicit selection and grant no trading authority. Existing perps operations retain their documented scopes.

Headers

Idempotency-Key
string
required

Per owner + public method/path + key. Same body replays the durable service result; changed body returns 409. Service retains records 180 days (at least 24 hours).

Required string length: 1 - 128
Pattern: ^[!-~]+$
If-Match
string
required

Positive configVersion or quoted ETag. Guards config edits; service state transitions do not increment configVersion.

Path Parameters

id
string<uuid>
required

Body

application/json
chain
enum<string>
required
Available options:
solana,
ethereum,
base,
bnb,
arbitrum,
polygon,
monad,
hyperevm,
robinhood
token
string
required

Base58 Solana mint or 0x-prefixed 40-hex EVM address, according to chain. Fresh qualified service data is required.

Maximum string length: 128
direction
enum<string>
required
Available options:
above,
below
thresholdUsd
string
required

Positive exact USD decimal. At most 20 whole digits/18 fractional digits; must also fit the service evaluator's decimal range.

Maximum string length: 128
Pattern: ^\d+(\.\d{1,18})?$
repeat
enum<string>
required
Available options:
once,
crossing
cooldownSeconds
integer
required

Existing evaluator accepts whole minutes only.

Required range: 60 <= x <= 86400Must be a multiple of 60
expiresAtMs
integer
required

Explicit expiry after now and at most 30 days away; enforced by service.

Required range: 0 <= x <= 9007199254740991

Response

Owner-scoped projection; unknown observations remain null. Cache-Control: no-store.

data
object
required
meta
object
required