Users
These API endpoints are related to users on Omniplex
Returns the booster status of a user. This can be used to check eligibility to redeem booster perks.
id*stringUser ID
Success
application/json- response
is_booster?booleanWhether the user is a booster
remark?stringAny issues found when checking booster status
curl -X GET 'https://spider.omniplex.gg/users/string/booster'{ "is_booster": true, "remark": "string"}Returns whether the user is boosting the main Omniplex Discord server, the listing their monthly booster premium goes to and when it next renews. Only the user themselves can check.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
Success
application/json- response
auto_vote_slots?integerExtra Auto-vote slots boosters get
boosting?booleanWhether the user is boosting the main Omniplex Discord server right now
boosting_since?stringWhen Omniplex first saw the current boost
date-timein_server?booleanWhether the user is in the main Omniplex Discord server
just_applied?booleanWhether this request applied a month of premium
last_claim_at?stringWhen booster premium was last applied
date-timelast_error?stringWhy the last renewal failed, if it did
next_renewal_at?stringWhen the next month of premium is due. Null without a listing or a boost
date-timepremium_days?integerDays of premium each renewal adds
renewal_days?integerDays between renewals
target?The listing the monthly premium goes to, or null if none is picked
curl -X GET 'https://spider.omniplex.gg/users/string/booster-perks'{ "auto_vote_slots": 0, "boosting": true, "boosting_since": "2019-08-24T14:15:22Z", "in_server": true, "just_applied": true, "last_claim_at": "2019-08-24T14:15:22Z", "last_error": "string", "next_renewal_at": "2019-08-24T14:15:22Z", "premium_days": 0, "renewal_days": 0, "target": { "avatar": "string", "name": "string", "target_id": "string", "target_type": "string" }}Picks the listing the user's monthly booster premium goes to, or clears it with null target_type and target_id. Only boosters can pick a listing. If a month is due, it's applied straight away and just_applied is true.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
target_id?stringtarget_type?string"bot""server"Success
application/json- response
auto_vote_slots?integerExtra Auto-vote slots boosters get
boosting?booleanWhether the user is boosting the main Omniplex Discord server right now
boosting_since?stringWhen Omniplex first saw the current boost
date-timein_server?booleanWhether the user is in the main Omniplex Discord server
just_applied?booleanWhether this request applied a month of premium
last_claim_at?stringWhen booster premium was last applied
date-timelast_error?stringWhy the last renewal failed, if it did
next_renewal_at?stringWhen the next month of premium is due. Null without a listing or a boost
date-timepremium_days?integerDays of premium each renewal adds
renewal_days?integerDays between renewals
target?The listing the monthly premium goes to, or null if none is picked
curl -X PUT 'https://spider.omniplex.gg/users/string/booster-perks' \ -H 'Content-Type: application/json' \ -d '{}'{ "auto_vote_slots": 0, "boosting": true, "boosting_since": "2019-08-24T14:15:22Z", "in_server": true, "just_applied": true, "last_claim_at": "2019-08-24T14:15:22Z", "last_error": "string", "next_renewal_at": "2019-08-24T14:15:22Z", "premium_days": 0, "renewal_days": 0, "target": { "avatar": "string", "name": "string", "target_id": "string", "target_type": "string" }}Returns the user's saved website customization settings, so they follow them across devices. prefs is empty and updated_at is null if they never saved any. Only the user themselves can read them.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
Success
application/json- response
prefs?The website's customization settings (theme, fonts, layout and content filters). Omniplex stores them as given
updated_at?stringWhen they were last saved, or null if never
date-timecurl -X GET 'https://spider.omniplex.gg/users/string/site-prefs'{ "prefs": { "property1": null, "property2": null }, "updated_at": "2019-08-24T14:15:22Z"}Saves the user's website customization settings, replacing what was there. prefs must be a JSON object of at most 8 KB. Only the user themselves can save them.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
prefs?Success
application/json- response
prefs?The website's customization settings (theme, fonts, layout and content filters). Omniplex stores them as given
updated_at?stringWhen they were last saved, or null if never
date-timecurl -X PUT 'https://spider.omniplex.gg/users/string/site-prefs' \ -H 'Content-Type: application/json' \ -d '{}'{ "prefs": { "property1": null, "property2": null }, "updated_at": "2019-08-24T14:15:22Z"}Returns whether the user is a member of the Omniplex Discord server. Only the user themselves can check.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
Success
application/json- response
member?booleanWhether the user is in the Omniplex Discord server
curl -X GET 'https://spider.omniplex.gg/users/string/main-server'{ "member": true}Returns the user's auto-vote subscription and the listings they auto-vote for. Only the user themselves can check.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
Success
application/json- response
billing_interval?stringmonth or year. month if the user never subscribed
booster_slots?integerFree slots the user gets for boosting the Omniplex Discord server, included in max_targets
cancel_at_period_end?booleanWhether the subscription ends at the end of the current period
current_period_end?stringWhen the current billing period ends
date-timeextra_slots?integerExtra listing slots bought on top of the included ones
max_extra_slots?integerThe most extra slots a subscription can have
max_targets?integerHow many listings can be auto-voted for, including extra slots
notify?stringHow the user hears about automatic votes: off, each (a notification for every vote) or daily (one summary a day)
price_cents?integerThe monthly price in US cents
slot_price_cents?integerThe price of one extra slot in US cents, per billing interval
status?stringThe Stripe subscription status, or empty if the user never subscribed
subscribed?booleanWhether the user has an active auto-vote subscription
targets?array<>The listings being auto-voted for
votes_24h?integerAutomatic votes cast in the last 24 hours, including for listings no longer on the list
votes_7d?integerAutomatic votes cast in the last 7 days, including for listings no longer on the list
yearly_price_cents?integerThe yearly plan's price in US cents
curl -X GET 'https://spider.omniplex.gg/users/string/auto-vote'{ "billing_interval": "string", "booster_slots": 0, "cancel_at_period_end": true, "current_period_end": "2019-08-24T14:15:22Z", "extra_slots": 0, "max_extra_slots": 0, "max_targets": 0, "notify": "string", "price_cents": 0, "slot_price_cents": 0, "status": "string", "subscribed": true, "targets": [ { "avatar": "string", "cooldown_until": "2019-08-24T14:15:22Z", "days": [ 0 ], "end_minute": 0, "in_schedule": true, "last_skip_reason": "string", "last_voted_at": "2019-08-24T14:15:22Z", "name": "string", "paused": true, "start_minute": 0, "target_id": "string", "target_type": "string", "timezone": "string", "votes_24h": 0, "votes_7d": 0 } ], "votes_24h": 0, "votes_7d": 0, "yearly_price_cents": 0}Replaces the listings the user auto-votes for (3, plus any extra slots they've bought), each with an optional weekday and time-of-day schedule and a pause switch, and optionally sets how the user hears about automatic votes. Returns 204 on success.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
notify?string"off""each""daily"targets?array<>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/auto-vote/targets' \ -H 'Content-Type: application/json' \ -d '{}'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Sets how many extra listing slots the user's Auto-vote subscription has, on top of the 3 included. Adding slots charges the prorated difference straight away and fails if the payment does. Removing slots credits the difference on the next invoice. Returns 204 on success.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
extra_slots?integerSuccess
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/auto-vote/slots' \ -H 'Content-Type: application/json' \ -d '{}'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Creates a Stripe Checkout session for the auto-vote subscription and returns its URL. The body is optional and can choose the monthly (default) or yearly plan and carry a promo code.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
plan?string"monthly""yearly"promo_code?stringSuccess
application/json- response
url?stringcurl -X POST 'https://spider.omniplex.gg/users/string/auto-vote/checkout' \ -H 'Content-Type: application/json' \ -d '{}'{ "url": "string"}Returns a Stripe billing portal URL where the user can update their card or cancel their auto-vote subscription.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
Success
application/json- response
url?stringcurl -X POST 'https://spider.omniplex.gg/users/string/auto-vote/portal'{ "url": "string"}Creates a data task for a user (delete or request). Returns the task id if this is successful.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
delete*stringWhether we should do a Data Deletion or a Data Request
Success
application/json- response
allow_unauthenticated?booleanWhether the task can be accessed without authentication
expiry?unknownThe task expiry.
task_id?stringThe ID of the newly created task
task_key?stringThe key of the newly created task
task_name?stringThe task name.
curl -X POST 'https://spider.omniplex.gg/users/string/data?delete=string'{ "allow_unauthenticated": true, "expiry": null, "task_id": "string", "task_key": "string", "task_name": "string"}Gets a user by id
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
Success
application/json- response
about?stringbanned?booleanbot_developer?booleanbug_hunters?booleancaptcha_sponsor_enabled?booleancertified?booleancreated_at?stringThe time the user was created
date-timeexperiments?array<>The experiments the user is in
extra_links?array<>The users links that it wishes to advertise
itag?stringThe user's internal ID. An artifact of database migrations.
uuidlast_booster_claim?stringThe last time the user claimed a booster reward
date-timepinned_target_id?stringThe ID of the listing the user pinned to their profile, null if none
pinned_target_type?stringThe type (bot or server) of the listing the user pinned to their profile, null if none
staff?booleanupdated_at?stringThe time the user was last updated
date-timeuser?user_bots?array<>user_packs?array<>The list of packs the user has
user_servers?array<>The servers owned by a team the user is on
user_teams?array<>vote_banned?booleancurl -X GET 'https://spider.omniplex.gg/users/string'{ "about": "string", "banned": true, "bot_developer": true, "bug_hunters": true, "captcha_sponsor_enabled": true, "certified": true, "created_at": "2019-08-24T14:15:22Z", "experiments": [ "string" ], "extra_links": [ { "name": "string", "value": "string" } ], "itag": "6b5f8e7b-1e8c-4611-b693-ee8faa950c62", "last_booster_claim": "2019-08-24T14:15:22Z", "pinned_target_id": "string", "pinned_target_type": "string", "staff": true, "updated_at": "2019-08-24T14:15:22Z", "user": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "user_bots": [ { "approximate_votes": 0, "asset_versions": { "property1": "string", "property2": "string" }, "boosted_until": "2019-08-24T14:15:22Z", "bot_id": "string", "card_color": "string", "clicks": 0, "created_at": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "hidden_stats": [ "string" ], "highlighted": true, "invite_clicks": 0, "library": "string", "nsfw": true, "premium": true, "servers": 0, "shards": 0, "short": "string", "spotlighted_until": "2019-08-24T14:15:22Z", "supporter_badge": true, "tags": [ "string" ], "type": "string", "user": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "vanity": "string", "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7", "views_30d": 0, "vote_blitz_until": "2019-08-24T14:15:22Z", "votes": 0 } ], "user_packs": [ { "bot_ids": [ "string" ], "bots": [ { "approximate_votes": 0, "asset_versions": { "property1": "string", "property2": "string" }, "boosted_until": "2019-08-24T14:15:22Z", "bot_id": "string", "card_color": "string", "clicks": 0, "created_at": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "hidden_stats": [ "string" ], "highlighted": true, "invite_clicks": 0, "library": "string", "nsfw": true, "premium": true, "servers": 0, "shards": 0, "short": "string", "spotlighted_until": "2019-08-24T14:15:22Z", "supporter_badge": true, "tags": [ "string" ], "type": "string", "user": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "vanity": "string", "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7", "views_30d": 0, "vote_blitz_until": "2019-08-24T14:15:22Z", "votes": 0 } ], "created_at": "2019-08-24T14:15:22Z", "emojis": [ { "animated": true, "downloads": 0, "id": "string", "name": "string", "position": 0, "vanity": "string" } ], "name": "string", "owner": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "pack_type": "string", "server_ids": [ "string" ], "servers": [ { "approximate_votes": 0, "asset_versions": { "property1": "string", "property2": "string" }, "avatar": "string", "boosted_until": "2019-08-24T14:15:22Z", "card_color": "string", "clicks": 0, "featured_until": "2019-08-24T14:15:22Z", "hidden_stats": [ "string" ], "highlighted": true, "invite_clicks": 0, "name": "string", "nsfw": true, "online_members": 0, "premium": true, "server_id": "string", "short": "string", "spotlighted_until": "2019-08-24T14:15:22Z", "state": "string", "supporter_badge": true, "tags": [ "string" ], "total_members": 0, "type": "string", "vanity": "string", "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7", "views_30d": 0, "votes": 0 } ], "short": "string", "sounds": [ { "downloads": 0, "duration_ms": 0, "id": "string", "name": "string", "position": 0, "vanity": "string" } ], "stickers": [ { "animated": true, "downloads": 0, "id": "string", "name": "string", "position": 0, "vanity": "string" } ], "tags": [ "string" ], "url": "string", "vote_banned": true, "votes": 0 } ], "user_servers": [ { "approximate_votes": 0, "asset_versions": { "property1": "string", "property2": "string" }, "avatar": "string", "boosted_until": "2019-08-24T14:15:22Z", "card_color": "string", "clicks": 0, "featured_until": "2019-08-24T14:15:22Z", "hidden_stats": [ "string" ], "highlighted": true, "invite_clicks": 0, "name": "string", "nsfw": true, "online_members": 0, "premium": true, "server_id": "string", "short": "string", "spotlighted_until": "2019-08-24T14:15:22Z", "state": "string", "supporter_badge": true, "tags": [ "string" ], "total_members": 0, "type": "string", "vanity": "string", "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7", "views_30d": 0, "votes": 0 } ], "user_teams": [ { "approximate_votes": 0, "asset_versions": { "property1": "string", "property2": "string" }, "created_at": "2019-08-24T14:15:22Z", "entities": { "bots": [ { "approximate_votes": 0, "asset_versions": { "property1": "string", "property2": "string" }, "boosted_until": "2019-08-24T14:15:22Z", "bot_id": "string", "card_color": "string", "clicks": 0, "created_at": "2019-08-24T14:15:22Z", "featured_until": "2019-08-24T14:15:22Z", "hidden_stats": [ "string" ], "highlighted": true, "invite_clicks": 0, "library": "string", "nsfw": true, "premium": true, "servers": 0, "shards": 0, "short": "string", "spotlighted_until": "2019-08-24T14:15:22Z", "supporter_badge": true, "tags": [ "string" ], "type": "string", "user": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "vanity": "string", "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7", "views_30d": 0, "vote_blitz_until": "2019-08-24T14:15:22Z", "votes": 0 } ], "members": [ { "created_at": "2019-08-24T14:15:22Z", "data_holder": true, "flags": [ "string" ], "itag": "6b5f8e7b-1e8c-4611-b693-ee8faa950c62", "mentionable": true, "service": "string", "team_id": "string", "user": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" } } ], "servers": [ { "approximate_votes": 0, "asset_versions": { "property1": "string", "property2": "string" }, "avatar": "string", "boosted_until": "2019-08-24T14:15:22Z", "card_color": "string", "clicks": 0, "featured_until": "2019-08-24T14:15:22Z", "hidden_stats": [ "string" ], "highlighted": true, "invite_clicks": 0, "name": "string", "nsfw": true, "online_members": 0, "premium": true, "server_id": "string", "short": "string", "spotlighted_until": "2019-08-24T14:15:22Z", "state": "string", "supporter_badge": true, "tags": [ "string" ], "total_members": 0, "type": "string", "vanity": "string", "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7", "views_30d": 0, "votes": 0 } ], "targets": [ "string" ] }, "extra_links": [ { "name": "string", "value": "string" } ], "id": "string", "name": "string", "nsfw": true, "service": "string", "short": "string", "tags": [ "string" ], "updated_at": "2019-08-24T14:15:22Z", "vanity": "string", "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7", "vote_banned": true, "votes": 0 } ], "vote_banned": true}Updates a users profile. Returns 204 on success
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringUser ID
application/json- body
about?stringcaptcha_sponsor_enabled?booleanextra_links?array<>pinned_listing?Pin a bot or server you own or manage to your profile. Send an empty target_id to unpin.
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X PATCH 'https://spider.omniplex.gg/users/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Gets a users permissions by ID
id*stringUser ID
Success
application/json- response
banned?booleancaptcha_sponsor_enabled?booleanexperiments?array<string>staff?booleanuser?vote_banned?booleancurl -X GET 'https://spider.omniplex.gg/users/string/perms'{ "banned": true, "captcha_sponsor_enabled": true, "experiments": [ "string" ], "staff": true, "user": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "vote_banned": true}Returns a user's voter leaderboard positions (this month and all time), the listed bots and servers they've upvoted most, and their most recent reviews. Only listed, non-NSFW bots and servers are included.
id*stringThe user's ID
Success
application/json- response
all_time?The user's all-time voter leaderboard position
month?The user's voter leaderboard position since the last monthly vote reset
reviews?array<>The user's most recent top-level reviews on listed, non-NSFW bots and servers
top_voted?array<>The listed, non-NSFW bots and servers the user has upvoted most, all time
curl -X GET 'https://spider.omniplex.gg/users/string/activity'{ "all_time": { "next_reset": "2019-08-24T14:15:22Z", "period_start": "2019-08-24T14:15:22Z", "rank": 0, "total_voters": 0, "votes": 0 }, "month": { "next_reset": "2019-08-24T14:15:22Z", "period_start": "2019-08-24T14:15:22Z", "rank": 0, "total_voters": 0, "votes": 0 }, "reviews": [ { "content": "string", "created_at": "2019-08-24T14:15:22Z", "id": "string", "stars": 0, "target": { "avatar": "string", "name": "string", "target_id": "string", "target_type": "string", "vanity": "string", "votes": 0 } } ], "top_voted": [ { "avatar": "string", "name": "string", "target_id": "string", "target_type": "string", "vanity": "string", "votes": 0 } ]}Gets a users SEO data by id
id*stringUser ID
Success
application/json- response
avatar?stringThe entities resolved avatar URL (not just hash)
id?stringID of the entity
name?stringName of the entity
short?stringShort description of the entity
vanity?stringThe entity's vanity code, used to build its canonical URL. Omitted when it has none
curl -X GET 'https://spider.omniplex.gg/users/string/seo'{ "avatar": "string", "id": "string", "name": "string", "short": "string", "vanity": "string"}