A code's totals and commission
API v2 - coming soon.
Coming soon
Needs your v2 key
401 legacy_key. How to get a v2 keyLifetime referrals, active referrals, first deposits, wagered, deposited, and commission earned, claimed and claimable.
Rate limits: 60 reads a minute per IP across /api/v2 and at most 25 to one path in 2 seconds (429 with Retry-After), and 60 a minute per account across its keyed reads.
partnerKeyx-apikey<token>Your API v2 key (cgw2_...)
code*stringThe affiliate code (letter case ignored)
1 <= length <= 191currency?stringThe currency of the answer's amounts: COINS (the default, the answer as it always was) or USD, EUR or GBP, converted at the rate the site shows and rounded to two decimals as the site writes them. Anything else is a 400 unknown_currency.
"COINS""COINS""USD""EUR""GBP"OK
application/json- response
code*stringreferrals*integerPlayers who joined with the code
activeReferrals*integerReferrals who wagered in the last 7 days
firstDeposits*integerReferrals whose first deposit was under the code
wagered*numberWagered by the referrals, in coins with two decimals (in the currency asked, when one is)
deposited*numberDeposited by the referrals, in coins with two decimals (in the currency asked, when one is)
commission*currency?What the amounts were converted to, when currency was USD, EUR or GBP. Absent for coins
curl "https://api.csgowin.com/api/v2/affiliates/YOUR_CODE/summary" \ -H "x-apikey: YOUR_V2_KEY"{ "code": "EXAMPLE-AFFILIATE", "referrals": 120, "activeReferrals": 14, "firstDeposits": 37, "wagered": 18250.4, "deposited": 5300, "commission": { "earned": 91.25, "claimed": 60, "claimable": 31.25 }}Errors
| Status | When | Body |
|---|---|---|
| 400 | bad_request: an input outside its rules, a cookie sent, or a refusal by the site (the message says which). unknown_currency: currency is not one of COINS, USD, EUR, GBP. | {"error":{"code":"bad_request","message":"code: Too big: expected string to have <=191 characters"}}{"error":{"code":"unknown_currency","message":"currency is one of COINS, USD, EUR, GBP"}} |
| 401 | missing_key: no key in the x-apikey header. legacy_key: a v1 key - switch to API v2 for a v2 key. invalid_key: not a live API v2 key, or the code is not one of its account’s codes. | {"error":{"code":"missing_key","message":"send your API v2 key in the x-apikey header"}}{"error":{"code":"legacy_key","message":"this is a v1 key: switch to API v2 in Profile > Affiliates > API key to get a v2 key"}}{"error":{"code":"invalid_key","message":"the key is not a live API v2 key of this code"}} |
| 403 | key_blocked: API v2 is blocked for the account - contact support (a new key does not lift it). account_restricted: the account is restricted - contact support. | {"error":{"code":"key_blocked","message":"this key is blocked: contact support"}}{"error":{"code":"account_restricted","message":"this account is restricted: contact support"}} |
| 404 | not_found: no such giveaway, case or period, or the code has no board or giveaways (also every request while API v2 is not open, and every action while actions are not open). | {"error":{"code":"not_found","message":"not found"}} |
| 409 | stats_not_ready: the code’s figures are being prepared - try again in a few minutes. | {"error":{"code":"stats_not_ready","message":"the stats of this code are being prepared: try again in a few minutes. If this lasts, open the code's affiliate page on the site"}} |
| 429 | rate_limited: past a rate limit - wait the Retry-After seconds. | {"error":{"code":"rate_limited","message":"too many requests, please try again later."}} |
| 503 | unavailable: not available for a moment and nothing was done - try again after the Retry-After seconds. | {"error":{"code":"unavailable","message":"temporarily unavailable, please try again shortly."}} |
Remove a coming-up leaderboard period POST
Removes a period of your own board that has not started, as your board page does, and makes its configuration available again. A running or ended period stays. Another board's period answers 404. 20 a day. Rate limits: 5 actions a minute per account (429 rate_limited), this action’s count per UTC day (429 action_limit_reached, Retry-After to 00:00 UTC), and 120 actions a minute across the site (503 unavailable with Retry-After).
A code's referrals GET
The referral table: all time, or summed over a window (UTC days) when from or to is given. Sorted by wagered, deposited, joinedAt or name. Sorting by wagered or deposited lists only the referrals with a positive figure of that kind. The whole table in one call: limit=50000, a bulk read (a limit over 100, or a window over 366 days) once a minute per account. Rate limits: 60 reads a minute per IP across /api/v2 and at most 25 to one path in 2 seconds (429 with Retry-After), and 60 a minute per account across its keyed reads, and a bulk read once a minute per account (429 with Retry-After).