Skip to main content

Read statements

Monthly revenue-share / rebate statements.

List​

GET /api/v1/cex/statements — keyset-paginated.

ParamNotes
fromMonth / toMonthYYYY-MM
cursor, limit1–200 (default 50)

One month​

GET /api/v1/cex/statements/{periodMonth} — periodMonth is YYYY-MM. Months with no activity synthesize to zeros with periodStatus: OPEN and isFinal: false — they never 404.

Fields: periodMonth, product, revenueSharePct, discountGrantedUsd, rebateAccruedUsd, rebatePaidUsd, rebateOwedUsd (signed), payoutRef (nullable), payoutStatus (nullable), periodStatus (OPEN | ROLLED), isFinal. All money as 6-dp strings.

curl https://api.orbitum.io/api/v1/cex/statements/2026-08 \
-H "X-Api-Key: $ORBITUM_API_KEY"

Exports​

  • GET /api/v1/cex/statements/export — CSV of the filtered list.
  • GET /api/v1/cex/statements/{periodMonth}/pdf — one-month PDF.

Both stream directly (not enveloped) and are rate-limited to 5/min.