Skip to main content

API Overview

What the API does, base URLs, and global rules.

C
Written by Catalin Fetean
Updated over 2 months ago

Audience: Developers, Architects
​Outcomes: You know exactly what’s possible and how to call it.

Scope: Contracts, Orders, Deliverables, Payments (cards/bank/crypto), Escrow, Disputes, Invoices, Admin, Webhooks, SSE, Metrics.

Base URLs

  • Production: https://api.your-tradeos-domain.com

  • Sandbox: https://sandbox.api.your-tradeos-domain.com

Conventions

  • Auth: secure session cookie connect.sid from /api/auth/login (optional X-API-Key).

  • Amounts: minor units (e.g., 150000 = $1,500.00).

  • Timestamps: UTC ISO-8601.

  • Pagination: ?limit&cursor → response includes nextCursor.

  • Idempotency: stable reference in body or Idempotency-Key header.

  • Error shape:

{"code":"VALIDATION_ERROR","message":"Invalid payload","issues":[{"path":["amount"],"message":"Must be integer minor units"}]}

  • Default rate limit: 100 req/min per org; on 429, backoff with jitter and reuse your idempotency key.

Did this answer your question?