Omniplex Docs
PopplioStaging

List

These API endpoints are core endpoints of our list.

GET
/list/rss.xml

Get RSS Feed

Gets the RSS feed for the site, in XML format

/list/rss.xml
curl -X GET "https://spider-staging.omniplex.gg/list/rss.xml"

Success

null

GET
/list/sitemap.xml

Get Sitemap

Gets the sitemap for the site, in XML format

/list/sitemap.xml
curl -X GET "https://spider-staging.omniplex.gg/list/sitemap.xml"

Success

null

POST
/list/search

Search List

Searches the list returning a list of bots/servers that match the query

/list/search

Request Body

application/jsonRequired

querystring

serversobject

shardsobject

tagsobject

target_typesarray<string>

total_membersobject

votesobject

curl -X POST "https://spider-staging.omniplex.gg/list/search" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "string",
    "servers": {
      "from": 0,
      "to": 0
    },
    "shards": {
      "from": 0,
      "to": 0
    },
    "tags": {
      "tag_mode": "string",
      "tags": [
        "string"
      ]
    },
    "target_types": [
      "string"
    ],
    "total_members": {
      "from": 0,
      "to": 0
    },
    "votes": {
      "from": 0,
      "to": 0
    }
  }'

Success

{
  "bots": [
    {
      "approximate_votes": 0,
      "bot_id": "string",
      "clicks": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "invite_clicks": 0,
      "library": "string",
      "nsfw": true,
      "premium": true,
      "servers": 0,
      "shards": 0,
      "short": "string",
      "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",
      "votes": 0
    }
  ],
  "servers": [
    {
      "approximate_votes": 0,
      "avatar": "string",
      "clicks": 0,
      "invite_clicks": 0,
      "name": "string",
      "nsfw": true,
      "online_members": 0,
      "premium": true,
      "server_id": "string",
      "short": "string",
      "state": "string",
      "tags": [
        "string"
      ],
      "total_members": 0,
      "type": "string",
      "vanity": "string",
      "vanity_ref": "e1b95001-3370-4367-9787-1fb904c7b8c7",
      "votes": 0
    }
  ],
  "target_types": [
    "string"
  ]
}

GET
/list/stats

Get List Statistics

Gets basic statistics of the list

/list/stats
curl -X GET "https://spider-staging.omniplex.gg/list/stats"

Success

{
  "total_approved_bots": 0,
  "total_bots": 0,
  "total_certified_bots": 0,
  "total_packs": 0,
  "total_staff": 0,
  "total_tickets": 0,
  "total_users": 0,
  "total_votes": 0
}

GET
/list/partners

Get List Partners

Gets the official partners of the list

/list/partners
curl -X GET "https://spider-staging.omniplex.gg/list/partners"

Success

{
  "partner_types": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "icon": "string",
      "id": "string",
      "name": "string",
      "short": "string"
    }
  ],
  "partners": [
    {
      "bot_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "id": "string",
      "links": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "short": "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"
      }
    }
  ]
}

GET
/list/staff-templates

Get Staff Templates

Returns all of the staff templates used for reviewing bots

/list/staff-templates
curl -X GET "https://spider-staging.omniplex.gg/list/staff-templates"

Success

{
  "template_types": [
    {
      "icon": "string",
      "id": "string",
      "name": "string",
      "short": "string"
    }
  ],
  "templates": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "emoji": "string",
      "id": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "string"
    }
  ]
}

GET
/list/team

Get List Team

Gets an up to date listing of the staff team of the list. This is currently broken and does not handle permissions yet (TODO)

/list/team
curl -X GET "https://spider-staging.omniplex.gg/list/team"

Success

{
  "members": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "mfa_verified": true,
      "no_autosync": true,
      "perm_overrides": [
        "string"
      ],
      "positions": [
        {
          "corresponding_roles": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "created_at": "2019-08-24T14:15:22Z",
          "icon": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "index": 0,
          "name": "string",
          "perms": [
            "string"
          ],
          "role_id": "string"
        }
      ],
      "unaccounted": true,
      "user": {
        "avatar": "string",
        "bot": true,
        "display_name": "string",
        "extra_data": {
          "property1": null,
          "property2": null
        },
        "flags": [
          "string"
        ],
        "id": "string",
        "status": "string",
        "username": "string"
      }
    }
  ]
}

GET
/list/current-status

Get Current Status

Gets the current status of the list

/list/current-status

Query Parameters

src
Required
string

Source to use. If unspecified, defaults to instatus

curl -X GET "https://spider-staging.omniplex.gg/list/current-status?src=string"

Success

{
  "etc": "string",
  "key1": "string",
  "key2": "string",
  "key3": "string"
}

Previous

Blog

Next

Platform Specific