Votes
These API endpoints are related to votes and voting on Omniplex
Returns a list of all currently available vote credit tiers sorted in ascending order
target_type?stringThe target type to filter by. If unset, will not filter by target type.
Success
application/json- response
[index: integer]?curl -X GET 'https://spider.omniplex.gg/votes/credit-tiers'[ { "cents": 0, "created_at": "2019-08-24T14:15:22Z", "id": "string", "position": 0, "target_type": "string", "votes": 0 }]Returns the most active voters by upvotes cast, all-time or since the last monthly vote reset. Votes staff voided with a per-entity reset and votes from vote-banned or banned users are not counted. Cached for 5 minutes.
limit?stringHow many voters to return. Defaults to 10, capped at 50.
period?stringall (default) for all-time, or month for votes since the last monthly vote reset.
Success
application/json- response
[index: integer]?curl -X GET 'https://spider.omniplex.gg/votes/leaderboard'[ { "bot_votes": 0, "favorite": { "avatar": "string", "name": "string", "target_id": "string", "target_type": "string", "vanity": "string", "votes": 0 }, "other_votes": 0, "rank": 0, "server_votes": 0, "user": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "votes": 0 }]Returns one user's position on the voter leaderboard, counted the same way as Get Voter Leaderboard. A rank of 0 means the user has no counted upvotes in the period. Cached for 5 minutes.
user_id*stringThe user's ID
period?stringall (default) for all-time, or month for votes since the last monthly vote reset.
Success
application/json- response
next_reset?stringWhen monthly votes next reset: 00:00 UTC on the 1st, or a month later if staff already reset every listing type at the end of this month
date-timeperiod_start?stringWhen the period started, null for all-time
date-timerank?integerThe user's position on the leaderboard, 0 if they have no counted upvotes in the period
total_voters?integerHow many users have counted upvotes in the period
votes?integerThe user's upvote count in the period
curl -X GET 'https://spider.omniplex.gg/votes/leaderboard/users/string'{ "next_reset": "2019-08-24T14:15:22Z", "period_start": "2019-08-24T14:15:22Z", "rank": 0, "total_voters": 0, "votes": 0}Returns a summary of the tiers and the slab based breakdown of votes for a given entity
target_type*stringThe target type of the entity
target_id*stringThe target ID of the entity
Success
application/json- response
slab_overview?array<>Slab-based overview with each index, i, representing the amount of votes in Tiers[i]
tiers?array<>The vote credit tiers
total_credits?integerThe total amount of credits the user would get, in cents
vote_info?Some information about the vote
votes?integerThe amount of not-yet-redeemed votes the entity has available to convert -- excludes votes an earlier redemption already claimed, but not the entity's public vote total
curl -X GET 'https://spider.omniplex.gg/string/string/votes/credit-tiers'{ "slab_overview": [ 0 ], "tiers": [ { "cents": 0, "created_at": "2019-08-24T14:15:22Z", "id": "string", "position": 0, "target_type": "string", "votes": 0 } ], "total_credits": 0, "vote_info": { "multiple_votes": true, "per_user": 0, "supports_downvotes": true, "supports_partial_vote_credits_redeem": true, "supports_upvotes": true, "vote_credits": true, "vote_time": 0, "weekend_bonus": true }, "votes": 0}Returns a summary of the vote credit redeem logs
target_type*stringThe target type of the entity
target_id*stringThe target ID of the entity
Success
application/json- response
available_credits?integerThe total amount of credits that can be redeemed
redeemed_credits?integerThe total amount of credits that have been redeemed
redeems?array<>The vote credit redeem logs
total_credits?integerThe total amount of credits available
curl -X GET 'https://spider.omniplex.gg/string/string/votes/credits'{ "available_credits": 0, "redeemed_credits": 0, "redeems": [ { "created_at": "2019-08-24T14:15:22Z", "credits": 0, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "redeemed_at": "2019-08-24T14:15:22Z", "redeemed_credits": 0, "target_id": "string", "target_type": "string" } ], "total_credits": 0}Redeems votes into credits towards the shop based on the vote credit tiers
User-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
target_type*stringThe target type of the entity
target_id*stringThe target ID of the entity
votes*stringThe number of votes to redeem
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X POST 'https://spider.omniplex.gg/string/string/votes/credits?votes=string'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Gets all votes (paginated by 10) of a user on an entity. This endpoint is currently public as the same data can be found through #vote-logs in discord. Note that for compatibility, a trailing 's' is removed
uid*stringThe users ID
target_type*stringThe target type of the entity
target_id*stringThe target ID of the entity
page?stringThe page number
Success
application/json- response
count?integer0 <= value <= 18446744073709552000per_page?integer0 <= value <= 18446744073709552000results?array<>curl -X GET 'https://spider.omniplex.gg/users/string/string/string/votes/@all'{ "count": 0, "per_page": 0, "results": [ { "author": "string", "auto": true, "created_at": "2019-08-24T14:15:22Z", "credit_redeem": "d88a5dd2-1993-40f4-8f80-9b33ccb4e8e4", "immutable": true, "itag": "6b5f8e7b-1e8c-4611-b693-ee8faa950c62", "target_id": "string", "target_type": "string", "upvote": true, "void": true, "void_reason": "string", "voided_at": "2019-08-24T14:15:22Z", "vote_num": 0 } ]}Returns the users who have upvoted an entity, with their upvotes since the last vote reset and of all time, ordered by current votes, then all-time votes, then most recent vote. Voters whose profile can't be resolved are left out.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
target_type*stringThe target type of the entity
target_id*stringThe target ID of the entity
limit?stringHow many voters to return. Defaults to 24, capped at 100.
Success
application/json- response
total?integerHow many users have ever upvoted this entity
voters?array<>The voters, ordered by current votes, then all-time votes, then most recent vote
curl -X GET 'https://spider.omniplex.gg/string/string/votes/voters'{ "total": 0, "voters": [ { "last_voted_at": "2019-08-24T14:15:22Z", "total_votes": 0, "user": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "votes": 0 } ]}Gets the full list of all users who have voted for the entity on Discord as a list of snowflakes. Note that for compatibility, a trailing 's' is removed. This method does not require authentication as it is easily publicly available through other means
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
target_type*stringThe target type of the entity
target_id*stringThe target ID of the entity
page?stringThe page number (if pagination is desired, otherwise sends all results)
Success
application/json- response
[index: integer]?stringcurl -X GET 'https://spider.omniplex.gg/string/string/votes/user-list'[ "string"]Gets all valid (current) votes a user has made for an entity
uid*stringThe users ID
target_type*stringThe target type of the entity
target_id*stringThe target ID
Success
application/json- response
has_voted?booleanWhether or not the user has voted for the entity. If an entity supports multiple votes, this will be true if the user has voted in the last vote time, otherwise, it will be true if the user has voted at all
valid_votes?array<>A list of all non-voided votes the user has made on the entity
vote_info?Some information about the vote
wait?The time until the user can vote again
curl -X GET 'https://spider.omniplex.gg/users/string/string/string/votes'{ "has_voted": true, "valid_votes": [ { "author": "string", "auto": true, "created_at": "2019-08-24T14:15:22Z", "credit_redeem": "d88a5dd2-1993-40f4-8f80-9b33ccb4e8e4", "immutable": true, "itag": "6b5f8e7b-1e8c-4611-b693-ee8faa950c62", "target_id": "string", "target_type": "string", "upvote": true, "void": true, "void_reason": "string", "voided_at": "2019-08-24T14:15:22Z", "vote_num": 0 } ], "vote_info": { "multiple_votes": true, "per_user": 0, "supports_downvotes": true, "supports_partial_vote_credits_redeem": true, "supports_upvotes": true, "vote_credits": true, "vote_time": 0, "weekend_bonus": true }, "wait": { "hours": 0, "minutes": 0, "seconds": 0 }}Creates a vote for an entity. Returns 204 on success. Note that for compatibility, a trailing 's' is removed. If the target is a bot or server that has not opted out of captchas, the request body must be {"token": "..."} with a Cloudflare Turnstile token rendered with the action "vote"
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
uid*stringThe users ID
target_type*stringThe target type of the entity
target_id*stringThe target ID
upvote*stringWhether or not to upvote the entity. Must be either true or false
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X PUT 'https://spider.omniplex.gg/users/string/string/string/votes?upvote=string'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}