Skip to Content
CSGOWINAPI
API v2 Coming soonLeaderboards

Remove a coming-up leaderboard period

API v2 - coming soon.

Coming soon

API v2 is not open yet - every request to it answers 404 until it launches, and the details on this page may still change. Build on API v1 today - it keeps working. New keys and a one-step switch will arrive with v2.
POST
/api/v2/leaderboards/{code}/periods/{periodId}/remove

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).

Authorization

partnerKey
headerx-apikey<token>

Your API v2 key (cgw2_...)

Path Parameters

code*string

The affiliate code (letter case ignored)

Length1 <= length <= 191
periodId*integer

The period, from its board

Range0 < value

Header Parameters

Idempotency-Key*string

A new value per action (a UUID): a resend with the same value answers the first answer and does nothing again

Match^[A-Za-z0-9_-]{8,64}$

Request Body

application/json
  1. body

Response Body

Done

application/json
  1. response
removed*boolean
configGivenBack*boolean

The board configuration it used is available again

actionId*integer

This action, as support finds it (also the X-Request-Id header)

spentToday*number

What actions spent today (UTC) against the daily limit, this one included, in coins with two decimals

dailyLimit*number

The daily limit in force, in coins with two decimals

Example Request
curl -X POST "https://api.csgowin.com/api/v2/leaderboards/YOUR_CODE/periods/61/remove" \  -H "x-apikey: YOUR_V2_KEY" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{}'
Example Response
{  "removed": true,  "configGivenBack": true,  "actionId": 1201,  "spentToday": 50,  "dailyLimit": 100}

Errors

StatusWhenBody
400bad_request: an input outside its rules, a cookie sent, or a refusal by the site (the message says which).{"error":{"code":"bad_request","message":"send an Idempotency-Key header: 8 to 64 letters, digits, - or _ (a new UUID per action)"}}
401missing_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"}}
403key_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. actions_not_enabled: "Let tools act for me" is not ticked for this key. second_factor_required: the account has no two-factor authentication. staff_account: a staff account never acts through a key.{"error":{"code":"key_blocked","message":"this key is blocked: contact support"}}{"error":{"code":"account_restricted","message":"this account is restricted: contact support"}}{"error":{"code":"actions_not_enabled","message":"this key may not act: tick \"Let tools act for me\" in Profile > Affiliates > API key"}}{"error":{"code":"second_factor_required","message":"set up two-factor authentication on your account to let tools act for you"}}{"error":{"code":"staff_account","message":"a staff account never acts through a key"}}
404not_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"}}
409idempotency_in_progress: the action with this Idempotency-Key is still running. outcome_unknown: the action with this Idempotency-Key has an unknown outcome - do not resend, contact support.{"error":{"code":"idempotency_in_progress","message":"the action with this Idempotency-Key is still running"}}{"error":{"code":"outcome_unknown","message":"the action with this Idempotency-Key ended in an unexpected error: contact support with its request id, do not resend"}}
422idempotency_mismatch: this Idempotency-Key came with another request - use a new one.{"error":{"code":"idempotency_mismatch","message":"this Idempotency-Key was sent with another request: use a new Idempotency-Key"}}
429rate_limited: past a rate limit - wait the Retry-After seconds. daily_limit_reached: the giveaway’s prize would pass the daily limit - Retry-After counts down to 00:00 UTC. action_limit_reached: this action’s count for today is used up - Retry-After counts down to 00:00 UTC.{"error":{"code":"rate_limited","message":"more than 5 actions a minute for this account"}}{"error":{"code":"daily_limit_reached","message":"the daily limit of 100 coins would be passed (80 spent today) - it resets at 2030-11-17T00:00:00.000Z"}}{"error":{"code":"action_limit_reached","message":"this action's count for today is used up - it resets at 2030-11-17T00:00:00.000Z"}}
500internal: the action’s outcome is unknown - do not resend, contact support with the X-Request-Id.{"error":{"code":"internal","message":"the outcome of this action is unknown: contact support with its request id, do not resend"}}
503unavailable: not available for a moment and nothing was done - try again after the Retry-After seconds.{"error":{"code":"unavailable","message":"actions are paused for a moment, try again in a minute"}}