Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer token from Geomi. See Authentication for setup instructions.

Headers

Prefer
string

RFC 7240. include-unknown-enum-members opts into campaign types/statuses added after the published baseline; honored requests get Preference-Applied back.

Response

Active campaigns

campaign_id
integer<int64>
required
Required range: x >= 0
campaign_type
required

Extensible enum: clients must accept values not listed here. Types beyond the baseline are returned only when the request sends Prefer: include-unknown-enum-members.

Available options:
fee_rebate,
maker_incentive,
liquidation_rebate,
volume_milestone,
first_funded_trial,
affiliate,
discretionary
claim_end_ts_sec
integer<int64>
required
Required range: x >= 0
claim_start_ts_sec
integer<int64>
required
Required range: x >= 0
end_ts_sec
integer<int64>
required
Required range: x >= 0
reward_asset
string
required
start_ts_sec
integer<int64>
required
Required range: x >= 0
status
required

Extensible enum: clients must accept values not listed here. Statuses beyond the baseline are returned only when the request sends Prefer: include-unknown-enum-members.

Available options:
draft,
funded,
active,
expired,
reclaimed,
cancelled
title
string
required
total_funded
integer<int64>
required

Reward-asset subunits; divide by the asset's decimals client-side for display.

Required range: x >= 0
description
string | null