Projects

Show all listings projects based on filters, showing votes for current season

get
Query parameters
userkeystringOptional
yearnumberOptional
periodnumberOptional
limitinteger · max: 100OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
chevron-right
200

Successful response

application/json
get
/projects

Get suggested listings projects for a user. Supports time scope: global (all-time), current-period (default), or specific period.

get
Query parameters
limitnumberOptionalDefault: 5
scopestring · enumOptionalDefault: current-periodPossible values:
startDatestringOptional
endDatestringOptional
yearintegerOptional
periodintegerOptional
Responses
chevron-right
200

Successful response

application/json
get
/projects/suggested

Get a specific listing project by ID

get
Path parameters
projectIdinteger · max: 2147483647Required
Responses
chevron-right
200

Successful response

application/json
get
/projects/{projectId}

Update an existing project (Admin or Project Owner only)

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
projectIdinteger · max: 2147483647Required
Body
descriptionstringOptional
bannerImageUrlstring · uri | nullableOptional
categoryIdsinteger[]Optional
chainsinteger[]Optional
isPromotedbooleanOptional
launchDatestringOptional
statusstring · enumOptionalPossible values:
Responses
chevron-right
200

Successful response

application/json
put
/projects/{projectId}

Get detailed information for a specific project, showing votes for current season

get
Path parameters
projectIdinteger · max: 2147483647Required
Query parameters
topVotersLimitnumber · max: 100OptionalDefault: 3
yearnumberOptional
periodnumberOptional
Responses
chevron-right
200

Successful response

application/json
get
/projects/{projectId}/details

Get detailed information for a specific project by username, showing votes for current season

get
Path parameters
usernamestringRequired
Query parameters
topVotersLimitnumberOptionalDefault: 3
yearnumberOptional
periodnumberOptional
Responses
chevron-right
200

Successful response

application/json
get
/projects/username/{username}

Show team members for a listings project

get
Path parameters
projectIdinteger · max: 2147483647Required
Query parameters
limitinteger · max: 50OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
chevron-right
200

Successful response

application/json
get
/projects/{projectId}/team

Add team members to a project (Admin or Project Owner only)

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
projectIdinteger · max: 2147483647Required
Body
userIdsinteger[]Required
Responses
chevron-right
200

Successful response

application/json
Responseany
post
/projects/{projectId}/team

No content

Remove a team member from a project (Admin or Project Owner only)

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
projectIdinteger · max: 2147483647Required
Query parameters
userIdsinteger[]Required
Responses
chevron-right
200

Successful response

application/json
Responseany
delete
/projects/{projectId}/team

No content

Add a chain to a project (Admin or Project Owner only)

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
projectIdnumberRequired
Body
chainIdnumberRequired
Responses
chevron-right
200

Successful response

application/json
post
/projects/{projectId}/chains

Remove a chain from a project (Admin or Project Owner only)

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
projectIdnumberRequired
chainIdnumberRequired
Responses
chevron-right
200

Successful response

application/json
delete
/projects/{projectId}/chains/{chainId}

Confirm project creation using a token (Admin only)

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
userkeystringRequired
timeoutnumberOptionalDefault: 30000
Responses
chevron-right
200

Successful response

application/json
get
/projects/confirm

Last updated