API Reference

CLIST

CLIST is a platform that aggregates competitive programming contests from various sources and provides an API for accessing contest information.

Back to Platforms Refresh Docs

Platforms

Endpoints

ACTIVE

Platform Status

Endpoint Overview

A template-style view of the available API surface for this platform.

15 total

clist.health

GET

GET /api/clist/health

Get CLIST API integration health.

Route Name

clist.health

Action

health

Method

GET

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.endpoints

GET

GET /api/clist/endpoints

List every exposed CLIST endpoint.

Route Name

clist.endpoints

Action

endpoints

Method

GET

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.accounts

GET

GET /api/clist/accounts

Retrieve accounts.

Route Name

clist.accounts

Action

accounts

Method

GET

Try this endpoint

Query Parameters

limit integer optional

Number of elements to display per page.

Example: 20

offset integer optional

Offset to start displaying elements on a page.

Example: 1

total_count boolean optional

Include total item count in response metadata.

Example: true

id integer optional

Filter by id.

Example: 2673

id__in integer optional

Filter by id in.

Example: 2673,2674

resource_id integer optional

Filter by resource_id.

Example: 2673

resource_id__in integer optional

Filter by resource_id in.

Example: 2673,2674

resource string optional

Filter by resource.

Example: codeforces.com

resource__regex string optional

Filter by resource regex.

Example: codeforces

resource__iregex string optional

Filter by resource iregex.

Example: codeforces

resource__in string optional

Filter by resource in.

Example: codeforces.com,atcoder.jp

handle string optional

Filter by handle.

Example: codeforces.com

handle__in string optional

Filter by handle in.

Example: codeforces.com,atcoder.jp

handle__startswith string optional

Filter by handle startswith.

Example: codeforces

rating integer optional

Filter by rating.

Example: 2673

rating__gt integer optional

Filter by rating gt.

Example: 2673

rating__lt integer optional

Filter by rating lt.

Example: 2673

rating__gte integer optional

Filter by rating gte.

Example: 2673

rating__lte integer optional

Filter by rating lte.

Example: 2673

rating__isnull integer optional

Filter by rating isnull.

Example: 2673

resource_rank integer optional

Filter by resource_rank.

Example: 2673

resource_rank__gt integer optional

Filter by resource_rank gt.

Example: 2673

resource_rank__lt integer optional

Filter by resource_rank lt.

Example: 2673

resource_rank__gte integer optional

Filter by resource_rank gte.

Example: 2673

resource_rank__lte integer optional

Filter by resource_rank lte.

Example: 2673

resource_rank__isnull integer optional

Filter by resource_rank isnull.

Example: 2673

last_activity datetime optional

Filter by last_activity.

Example: 2010-11-10T03:07:43

last_activity__gt datetime optional

Filter by last_activity gt.

Example: 2010-11-10T03:07:43

last_activity__lt datetime optional

Filter by last_activity lt.

Example: 2010-11-10T03:07:43

last_activity__gte datetime optional

Filter by last_activity gte.

Example: 2010-11-10T03:07:43

last_activity__lte datetime optional

Filter by last_activity lte.

Example: 2010-11-10T03:07:43

last_activity__week_day datetime optional

Filter by last_activity week_day.

Example: 1

order_by string optional

Order results; prefix a field with - for descending order.

Example: id,-id,rating,-rating,resource_rank,-resource_rank,last_activity,-last_activity

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.accounts.detail

GET

GET /api/clist/accounts/{id}

Retrieve a single account.

Route Name

clist.accounts.detail

Action

accounts.detail

Method

GET

Try this endpoint

Path Parameters

id integer required

Account ID

Example: 2673

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.coders

GET

GET /api/clist/coders

Retrieve coders.

Route Name

clist.coders

Action

coders

Method

GET

Try this endpoint

Query Parameters

limit integer optional

Number of elements to display per page.

Example: 20

offset integer optional

Offset to start displaying elements on a page.

Example: 1

total_count boolean optional

Include total item count in response metadata.

Example: true

with_accounts boolean optional

Include linked accounts.

Example: true

country string optional

Filter by country code.

Example: BD

id integer optional

Filter by id.

Example: 2673

id__in integer optional

Filter by id in.

Example: 2673,2674

handle string optional

Filter by handle.

Example: codeforces.com

handle__in string optional

Filter by handle in.

Example: codeforces.com,atcoder.jp

is_virtual boolean optional

Filter virtual coders.

Example: false

order_by string optional

Order results; prefix a field with - for descending order.

Example: id,-id,n_accounts,-n_accounts

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.coders.me

GET

GET /api/clist/coders/me

Retrieve the authenticated coder.

Route Name

clist.coders.me

Action

coders.me

Method

GET

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.coders.detail

GET

GET /api/clist/coders/{id}

Retrieve a single coder.

Route Name

clist.coders.detail

Action

coders.detail

Method

GET

Try this endpoint

Path Parameters

id integer required

Coder ID

Example: 2673

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.contests

GET

GET /api/clist/contests

Retrieve contests.

Route Name

clist.contests

Action

contests

Method

GET

Try this endpoint

Query Parameters

limit integer optional

Number of elements to display per page.

Example: 20

offset integer optional

Offset to start displaying elements on a page.

Example: 1

total_count boolean optional

Include total item count in response metadata.

Example: true

with_problems boolean optional

Include contest problems.

Example: true

upcoming boolean optional

Filter upcoming contests.

Example: true

format_time boolean optional

Format times using CLIST user preferences.

Example: true

start_time__during datetime optional

Filter contests starting during a relative time range.

Example: 10 days

end_time__during datetime optional

Filter contests ending during a relative time range.

Example: 10 days

id integer optional

Filter by id.

Example: 2673

id__in integer optional

Filter by id in.

Example: 2673,2674

resource_id integer optional

Filter by resource_id.

Example: 2673

resource_id__in integer optional

Filter by resource_id in.

Example: 2673,2674

resource string optional

Filter by resource.

Example: codeforces.com

resource__iregex string optional

Filter by resource iregex.

Example: codeforces

resource__regex string optional

Filter by resource regex.

Example: codeforces

resource__in string optional

Filter by resource in.

Example: codeforces.com,atcoder.jp

host string optional

Filter by host.

Example: codeforces.com

host__iregex string optional

Filter by host iregex.

Example: codeforces

host__regex string optional

Filter by host regex.

Example: codeforces

event string optional

Filter by event.

Example: codeforces.com

event__iregex string optional

Filter by event iregex.

Example: codeforces

event__regex string optional

Filter by event regex.

Example: codeforces

start datetime optional

Filter by start.

Example: 2010-11-10T03:07:43

start__gt datetime optional

Filter by start gt.

Example: 2010-11-10T03:07:43

start__lt datetime optional

Filter by start lt.

Example: 2010-11-10T03:07:43

start__gte datetime optional

Filter by start gte.

Example: 2010-11-10T03:07:43

start__lte datetime optional

Filter by start lte.

Example: 2010-11-10T03:07:43

start__week_day datetime optional

Filter by start week_day.

Example: 1

end datetime optional

Filter by end.

Example: 2010-11-10T03:07:43

end__gt datetime optional

Filter by end gt.

Example: 2010-11-10T03:07:43

end__lt datetime optional

Filter by end lt.

Example: 2010-11-10T03:07:43

end__gte datetime optional

Filter by end gte.

Example: 2010-11-10T03:07:43

end__lte datetime optional

Filter by end lte.

Example: 2010-11-10T03:07:43

end__week_day datetime optional

Filter by end week_day.

Example: 1

parsed_at datetime optional

Filter by parsed_at.

Example: 2010-11-10T03:07:43

parsed_at__gt datetime optional

Filter by parsed_at gt.

Example: 2010-11-10T03:07:43

parsed_at__lt datetime optional

Filter by parsed_at lt.

Example: 2010-11-10T03:07:43

parsed_at__gte datetime optional

Filter by parsed_at gte.

Example: 2010-11-10T03:07:43

parsed_at__lte datetime optional

Filter by parsed_at lte.

Example: 2010-11-10T03:07:43

duration integer optional

Filter by duration.

Example: 2673

duration__gt integer optional

Filter by duration gt.

Example: 2673

duration__lt integer optional

Filter by duration lt.

Example: 2673

duration__gte integer optional

Filter by duration gte.

Example: 2673

duration__lte integer optional

Filter by duration lte.

Example: 2673

n_statistics integer optional

Filter by n_statistics.

Example: 2673

n_statistics__gt integer optional

Filter by n_statistics gt.

Example: 2673

n_statistics__lt integer optional

Filter by n_statistics lt.

Example: 2673

n_statistics__gte integer optional

Filter by n_statistics gte.

Example: 2673

n_statistics__lte integer optional

Filter by n_statistics lte.

Example: 2673

n_problems integer optional

Filter by n_problems.

Example: 2673

n_problems__gt integer optional

Filter by n_problems gt.

Example: 2673

n_problems__lt integer optional

Filter by n_problems lt.

Example: 2673

n_problems__gte integer optional

Filter by n_problems gte.

Example: 2673

n_problems__lte integer optional

Filter by n_problems lte.

Example: 2673

filtered boolean optional

Apply authenticated user filters.

Example: true

category string optional

Contest category filter.

Example: api

order_by string optional

Order results; prefix a field with - for descending order.

Example: id,-id,start,-start,end,-end,duration,-duration,event,-event

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.contests.detail

GET

GET /api/clist/contests/{id}

Retrieve a single contest.

Route Name

clist.contests.detail

Action

contests.detail

Method

GET

Try this endpoint

Path Parameters

id integer required

Contest ID

Example: 2673

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.problems

GET

GET /api/clist/problems

Retrieve problems.

Route Name

clist.problems

Action

problems

Method

GET

Try this endpoint

Query Parameters

limit integer optional

Number of elements to display per page.

Example: 20

offset integer optional

Offset to start displaying elements on a page.

Example: 1

total_count boolean optional

Include total item count in response metadata.

Example: true

name string optional

Filter by name.

Example: codeforces.com

name__in string optional

Filter by name in.

Example: codeforces.com,atcoder.jp

time datetime optional

Filter by time.

Example: 2010-11-10T03:07:43

time__gt datetime optional

Filter by time gt.

Example: 2010-11-10T03:07:43

time__lt datetime optional

Filter by time lt.

Example: 2010-11-10T03:07:43

time__gte datetime optional

Filter by time gte.

Example: 2010-11-10T03:07:43

time__lte datetime optional

Filter by time lte.

Example: 2010-11-10T03:07:43

time__week_day datetime optional

Filter by time week_day.

Example: 1

contest_ids list optional

Filter by contest IDs.

Example: 1,2,3

contest_ids__contains list optional

Filter problems whose contest IDs contain the value.

Example: 1234

resource string optional

Filter by resource.

Example: codeforces.com

resource__iregex string optional

Filter by resource iregex.

Example: codeforces

resource__regex string optional

Filter by resource regex.

Example: codeforces

resource__in string optional

Filter by resource in.

Example: codeforces.com,atcoder.jp

resource_id integer optional

Filter by resource_id.

Example: 2673

resource_id__in integer optional

Filter by resource_id in.

Example: 2673,2674

slug string optional

Filter by slug.

Example: codeforces.com

slug__in string optional

Filter by slug in.

Example: codeforces.com,atcoder.jp

short string optional

Filter by short.

Example: codeforces.com

short__in string optional

Filter by short in.

Example: codeforces.com,atcoder.jp

url string optional

Filter by url.

Example: codeforces.com

url__regex string optional

Filter by url regex.

Example: codeforces

archive_url string optional

Filter by archive_url.

Example: codeforces.com

archive_url__regex string optional

Filter by archive_url regex.

Example: codeforces

n_attempts integer optional

Filter by n_attempts.

Example: 2673

n_attempts__gt integer optional

Filter by n_attempts gt.

Example: 2673

n_attempts__lt integer optional

Filter by n_attempts lt.

Example: 2673

n_attempts__gte integer optional

Filter by n_attempts gte.

Example: 2673

n_attempts__lte integer optional

Filter by n_attempts lte.

Example: 2673

n_accepted integer optional

Filter by n_accepted.

Example: 2673

n_accepted__gt integer optional

Filter by n_accepted gt.

Example: 2673

n_accepted__lt integer optional

Filter by n_accepted lt.

Example: 2673

n_accepted__gte integer optional

Filter by n_accepted gte.

Example: 2673

n_accepted__lte integer optional

Filter by n_accepted lte.

Example: 2673

n_partial integer optional

Filter by n_partial.

Example: 2673

n_partial__gt integer optional

Filter by n_partial gt.

Example: 2673

n_partial__lt integer optional

Filter by n_partial lt.

Example: 2673

n_partial__gte integer optional

Filter by n_partial gte.

Example: 2673

n_partial__lte integer optional

Filter by n_partial lte.

Example: 2673

n_hidden integer optional

Filter by n_hidden.

Example: 2673

n_hidden__gt integer optional

Filter by n_hidden gt.

Example: 2673

n_hidden__lt integer optional

Filter by n_hidden lt.

Example: 2673

n_hidden__gte integer optional

Filter by n_hidden gte.

Example: 2673

n_hidden__lte integer optional

Filter by n_hidden lte.

Example: 2673

n_total integer optional

Filter by n_total.

Example: 2673

n_total__gt integer optional

Filter by n_total gt.

Example: 2673

n_total__lt integer optional

Filter by n_total lt.

Example: 2673

n_total__gte integer optional

Filter by n_total gte.

Example: 2673

n_total__lte integer optional

Filter by n_total lte.

Example: 2673

rating integer optional

Filter by rating.

Example: 2673

rating__gt integer optional

Filter by rating gt.

Example: 2673

rating__lt integer optional

Filter by rating lt.

Example: 2673

rating__gte integer optional

Filter by rating gte.

Example: 2673

rating__lte integer optional

Filter by rating lte.

Example: 2673

favorite boolean optional

Filter user-favorite problems.

Example: true

note string optional

Filter by note.

Example: codeforces.com

note__in string optional

Filter by note in.

Example: codeforces.com,atcoder.jp

solved boolean optional

Filter solved problems.

Example: true

reject boolean optional

Filter rejected problems.

Example: false

system_solved boolean optional

Filter problems solved in the resource system.

Example: true

system_reject boolean optional

Filter problems rejected in the resource system.

Example: false

user_solved boolean optional

Filter user-marked solved problems.

Example: true

user_todo boolean optional

Filter user-marked todo problems.

Example: true

user_reject boolean optional

Filter user-marked rejected problems.

Example: false

order_by string optional

Order results; prefix a field with - for descending order.

Example: id,-id,time,-time,rating,-rating,n_accepted,-n_accepted

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.problems.detail

GET

GET /api/clist/problems/{id}

Retrieve a single problem.

Route Name

clist.problems.detail

Action

problems.detail

Method

GET

Try this endpoint

Path Parameters

id integer required

Problem ID

Example: 2673

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.resources

GET

GET /api/clist/resources

Retrieve resources.

Route Name

clist.resources

Action

resources

Method

GET

Try this endpoint

Query Parameters

limit integer optional

Number of elements to display per page.

Example: 20

offset integer optional

Offset to start displaying elements on a page.

Example: 1

total_count boolean optional

Include total item count in response metadata.

Example: true

id integer optional

Filter by id.

Example: 2673

id__in integer optional

Filter by id in.

Example: 2673,2674

name string optional

Filter by name.

Example: codeforces.com

name__in string optional

Filter by name in.

Example: codeforces.com,atcoder.jp

short string optional

Filter by short.

Example: codeforces.com

short__in string optional

Filter by short in.

Example: codeforces.com,atcoder.jp

n_accounts integer optional

Filter by n_accounts.

Example: 2673

n_accounts__gt integer optional

Filter by n_accounts gt.

Example: 2673

n_accounts__lt integer optional

Filter by n_accounts lt.

Example: 2673

n_accounts__gte integer optional

Filter by n_accounts gte.

Example: 2673

n_accounts__lte integer optional

Filter by n_accounts lte.

Example: 2673

n_contests integer optional

Filter by n_contests.

Example: 2673

n_contests__gt integer optional

Filter by n_contests gt.

Example: 2673

n_contests__lt integer optional

Filter by n_contests lt.

Example: 2673

n_contests__gte integer optional

Filter by n_contests gte.

Example: 2673

n_contests__lte integer optional

Filter by n_contests lte.

Example: 2673

order_by string optional

Order results; prefix a field with - for descending order.

Example: id,-id,name,-name,n_accounts,-n_accounts,n_contests,-n_contests

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.resources.detail

GET

GET /api/clist/resources/{id}

Retrieve a single resource.

Route Name

clist.resources.detail

Action

resources.detail

Method

GET

Try this endpoint

Path Parameters

id integer required

Resource ID

Example: 2673

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.statistics

GET

GET /api/clist/statistics

Retrieve statistics.

Route Name

clist.statistics

Action

statistics

Method

GET

Try this endpoint

Query Parameters

limit integer optional

Number of elements to display per page.

Example: 20

offset integer optional

Offset to start displaying elements on a page.

Example: 1

total_count boolean optional

Include total item count in response metadata.

Example: true

with_problems boolean optional

Include problem-level statistics.

Example: true

with_more_fields boolean optional

Include additional statistics fields.

Example: true

contest_id integer optional

Filter by contest_id.

Example: 2673

contest_id__in integer optional

Filter by contest_id in.

Example: 2673,2674

account_id integer optional

Filter by account_id.

Example: 2673

account_id__in integer optional

Filter by account_id in.

Example: 2673,2674

coder_id integer required

Filter by coder ID.

Example: 2673

place integer optional

Filter by place.

Example: 2673

place__gt integer optional

Filter by place gt.

Example: 2673

place__lt integer optional

Filter by place lt.

Example: 2673

place__gte integer optional

Filter by place gte.

Example: 2673

place__lte integer optional

Filter by place lte.

Example: 2673

place__isnull integer optional

Filter by place isnull.

Example: 2673

new_rating__isnull integer optional

Filter records where new rating is null or non-null.

Example: 1

rating_change__isnull integer optional

Filter records where rating change is null or non-null.

Example: 1

order_by string optional

Order results; prefix a field with - for descending order.

Example: id,-id,score,-score,place,-place,new_rating,-new_rating,rating_change,-rating_change,date,-date

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.

clist.api

GET

GET /api/clist/api

Pass through a CLIST API v4 path.

Route Name

clist.api

Action

api

Method

GET

Try this endpoint

Query Parameters

path string required

CLIST API v4 resource path, such as contest, account/123, or coder/me.

Example: contest

limit integer optional

Optional pass-through query parameter. Any extra query parameters are forwarded.

Example: 20

Query Params

Headers

Edit params, headers, or the URL itself, then send the request to inspect the live response.

Waiting to send a request.

READY

Press “Send Request” to call this endpoint.