Skip to main content
GET
Get Daily Activity

Authorizations

API-Key
string
header
required

The "API-Key" header should contain your API key.

API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

API-Nonce
string
header
required

The "API-Nonce" header should contain an always-increasing 64-bit integer, most commonly a Unix timestamp in milliseconds. Each request must use a nonce greater than the nonce of the previous request signed with the same API key.

Query Parameters

activity_date
string

Day variant: UTC trade date. Today or one of the previous 89 UTC days. Mutually exclusive with iiban, start_date, and end_date.

Required string length: 10
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
iiban
string

History variant: one to ten full IIBANs (Kraken account identifiers), comma-delimited. Empty, duplicate, or malformed values are a 400. Validity is a format check only, not account existence. An opted-out user still enrolled by the end of the range returns one existence stub without activity_date. Unknown or unattributed identifiers return an empty result. Visible entries return the full iiban; opted-out stubs omit it.

Required string length: 1 - 350
start_date
string

History variant: inclusive start, YYYY-MM-DD, in the last 90 UTC days. Required with iiban and end_date.

Required string length: 10
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
end_date
string

History variant: inclusive end, YYYY-MM-DD, in the last 90 UTC days. Required with iiban and start_date. Must be on or after start_date.

Required string length: 10
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
all_users
boolean
default:false

Day variant only. Include quiet users enrolled in your affiliate plan by the requested date who are still enrolled, including those enrolled more than 90 days ago. Users without reportable activity have empty products. Trading totals, active_users, and revision are unchanged. Using all_users=true with history returns 400. Keep this value unchanged when following next_cursor.

cursor
string

Value from next_cursor in a previous response. Pass it unchanged to request the next page; do not parse or construct it. A daily cursor used for a full-roster request, or vice versa, returns 400.

Minimum string length: 1
limit
integer<int32>
default:50

Page size. Defaults to 50 when omitted. Values over 200 are rejected.

Required range: 1 <= x <= 200

Response

200 - application/json

One page of affiliate daily activity.

One page of affiliate daily activity.

currency
string
required

Reporting currency for every monetary figure. Always USD today.

Example:

"USD"

generated_at
string<date-time>
required
limit
integer<int32>
required

Page size used for this response. Echo of request limit after the default of 50.

Required range: 1 <= x <= 200
activity_date
string

Day variant only. The UTC trade date every item shares.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
revision
string<date-time>

Day variant, first page only. When this partner's figures for that UTC day were last updated. Omitted when there is no activity, and on later pages. A later value on re-fetch means this partner's figures moved.

active_users
integer<int64>

Day variant, first page only. Count of enrolled users sharing reportable trading activity that day. Excludes quiet users and opted-out users, even when they appear in the roster. May be omitted when zero. Omitted on later pages; not a roster size or remaining-page count.

Required range: x >= 0
totals
object

Day variant, first page only. Totals for referred users who have not opted out, including people omitted from items because they are not enrolled in your plan. An empty map on a later page is omission, not a zero day.

next_cursor
string

Present when more results exist. Pass as cursor on the next request.

items
object[]

Referred users for this page. May be omitted when empty.

estimated
boolean

Day variant, first page only. Amounts for this date are an estimate of that calendar day, including the opted-out remainder. Omitted when exact.

opted_out
object

Day variant, first page only. Opted-out remainder. Day-wide payable is totals plus summary when summary is set.