DOCUMENTATIONv2

PUT

User Profile Data

Add symbol to watchlist

/api/v2/me/watchlist/{market_id}

AUTHENTICATIONBearer token · trading:writeAUTHORITATIVE OWNERmarket-preferencesCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Apply the requested transition to add symbol to watchlist through the authoritative trust service boundary.

WHEN THIS CALL IS USEFUL

Call this when an identity, compliance, relying-party, or trust agent workflow needs to apply the documented add symbol to watchlist transition after re-reading the current authoritative state so it can make a purpose-limited identity or assurance decision with current policy and lifecycle state.

OUTCOME · Revise and reconcile

What changes

Updates only the allowlisted add symbol to watchlist fields and version accepted by the authoritative owner; it grants no adjacent authority.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance add symbol to watchlist.
Separates subject identity, consent, evidence, provider output, review, issuer credentials, and relying-party acceptance instead of collapsing them into a universal trust score.

ISOLATION + AUTHORITY

Bearer subject, tenant, purpose, policy version, role, issuer, reviewer, provider, and relying-party boundaries remain distinct. The response or transition grants no payment, custody, settlement, publisher, matching, or trading authority and must not expose regulated evidence beyond the live schema.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required market_id (path) exactly as defined by the live contract.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the applicable purpose, policy version, consent or role basis, and required assurance before relying on this result.

WHAT TO DO NEXT

Re-read add symbol to watchlist using the canonical identifier returned by this operation.
Reconcile an ambiguous response with the same idempotency key before attempting another mutation.
Use the returned lifecycle state and policy version to choose the next least-privilege trust action; do not infer a missing stage.

AGENT GUIDANCE

Use add symbol to watchlist only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required market_id (path) exactly as defined by the live contract.
Treat policy availability, consent, evidence capture, completed checks, review, decision, credential issuance, validity, and relying-party acceptance as separate facts.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the trading:write scope.EXAMPLEBearer hc_live_…

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated key reused for every retry of the same logical mutation.EXAMPLElaunch-treasury-v1-001

Content-TypeheaderRequired

application/jsonSigned mutations accept canonical JSON only.EXAMPLEapplication/json

Content-DigestheaderRequired

RFC 9530 SHA-256 digestDigest of the exact transmitted body bytes.EXAMPLEsha-256=:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=:

Signature-InputheaderRequired

RFC 9421 signature parametersCovers @method, @path, content-digest, content-type, and idempotency-key; includes keyid, nonce, created, and expires.EXAMPLEsig1=("@method" "@path" "content-digest" "content-type" "idempotency-key");created=1786582800;expires=1786583100;nonce="01J…";keyid="machine-prod"

SignatureheaderRequired

Ed25519 HTTP Message SignatureSignature made by an active public key registered to the authenticated client.EXAMPLEsig1=:base64-signature:

market_idpathRequired

uppercase BASE-QUOTE · 2–12 alphanumeric characters per assetCanonical market identifier. Lowercase, underscore, and slash aliases are rejected; base and quote assets must differ.EXAMPLEBTC-USD

RESPONSES

Status and payload examples

200Market membership is present; changed is false when it was already present.Mutation completed · JSON RESPONSE+

{
  "watchlist_item_id": "9b51ed4c9c8f4aec85d1bd5520e40557",
  "market_id": "BTC-USD",
  "base_asset": "BTC",
  "quote_asset": "USD",
  "membership": "PRESENT",
  "version": 1,
  "added_at": "2026-08-13T21:00:00Z",
  "updated_at": "2026-08-13T21:00:00Z",
  "changed": true
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read add symbol to watchlist using the canonical identifier returned by this operation.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.

400The market identifier, Idempotency-Key, or required signed headers are malformed.Request must change · JSON RESPONSE+

{
  "code": "invalid_request",
  "message": "The market identifier, Idempotency-Key, or required signed headers are malformed."
}

INTEGRATION DECISIONinvalid_request

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

401The bearer credential or HTTP Message Signature is missing, expired, replayed, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential or HTTP Message Signature is missing, expired, replayed, or invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

403The credential lacks the required trading scope.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks the required trading scope."
}

INTEGRATION DECISIONinsufficient_scope

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for the authenticated profile, tenant brand, referral, funding, and account-lifecycle projections.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

422The market is not a canonical BASE-QUOTE identifier or uses the same asset on both sides.Request must change · JSON RESPONSE+

{
  "code": "invalid_market",
  "message": "The market is not a canonical BASE-QUOTE identifier or uses the same asset on both sides."
}

INTEGRATION DECISIONinvalid_market

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

503The authoritative market-preferences projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_unavailable",
  "message": "The authoritative market-preferences projection is unavailable."
}

INTEGRATION DECISIONidentity_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
STATE RECONCILIATION: Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

OPERATIONAL NOTES

Security and lifecycle guarantees

PUT replaces the V1 toggle with an explicit replay-safe ensure-present operation.
Reusing the operation after a successful transition returns membership PRESENT with changed=false; it never removes the market.
The empty request body, canonical path, and Idempotency-Key are bound by the RFC 9421 signature.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

POST/api/v1/profile/togglesymbolwatchlistPROFILE: Toggle Symbol to Watchlist

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗