List queues
curl --request GET \
--url https://api.simpl.gg/v1/queues \
--header 'api-key: <api-key>'import requests
url = "https://api.simpl.gg/v1/queues"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://api.simpl.gg/v1/queues', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.simpl.gg/v1/queues",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.simpl.gg/v1/queues"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.simpl.gg/v1/queues")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simpl.gg/v1/queues")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"total": 100,
"limit": 50,
"offset": 0,
"has_more": true,
"data": [
{
"queue_id": "ranked_2v2",
"name": "Ranked 2v2",
"enabled": true,
"max_players": 4,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"timeout": 120,
"heartbeat": false,
"heartbeat_timeout": 30,
"host_leave_behavior": "promote",
"lobby_ttl": 3600,
"invite_code_config": {
"enabled": true,
"length": 6,
"charset": "numeric",
"prefix": "SIMPL-"
},
"server_settings": {
"version_tag": "1.2.3",
"region": "iad",
"tier": "1x-2g",
"network_ports": [
{
"name": "game_udp",
"protocol": "udp",
"internal_port": 7777,
"external_port": 30412,
"host": "37.16.24.10",
"tls_enabled": false
}
],
"startup_args": "-log",
"ttl": 1,
"auto_restart": false,
"custom_data": {
"map": "forest",
"mode": "ctf"
}
},
"matchmaking": {
"teams": 2,
"players_per_team": 2,
"min_players_per_team": 1,
"min_teams": 2,
"team_composition": {
"monsters": {
"boss": 1
},
"hunters": {
"medic": 1,
"assault": 2
}
},
"use_version_from_state": false,
"timeout": 120,
"max_party_size": 4,
"rules": [
{
"type": "difference",
"field": "mmr",
"max_difference": 200
}
]
}
}
]
}Queues
List queues
GET
/
queues
List queues
curl --request GET \
--url https://api.simpl.gg/v1/queues \
--header 'api-key: <api-key>'import requests
url = "https://api.simpl.gg/v1/queues"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://api.simpl.gg/v1/queues', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.simpl.gg/v1/queues",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.simpl.gg/v1/queues"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.simpl.gg/v1/queues")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simpl.gg/v1/queues")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"total": 100,
"limit": 50,
"offset": 0,
"has_more": true,
"data": [
{
"queue_id": "ranked_2v2",
"name": "Ranked 2v2",
"enabled": true,
"max_players": 4,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"timeout": 120,
"heartbeat": false,
"heartbeat_timeout": 30,
"host_leave_behavior": "promote",
"lobby_ttl": 3600,
"invite_code_config": {
"enabled": true,
"length": 6,
"charset": "numeric",
"prefix": "SIMPL-"
},
"server_settings": {
"version_tag": "1.2.3",
"region": "iad",
"tier": "1x-2g",
"network_ports": [
{
"name": "game_udp",
"protocol": "udp",
"internal_port": 7777,
"external_port": 30412,
"host": "37.16.24.10",
"tls_enabled": false
}
],
"startup_args": "-log",
"ttl": 1,
"auto_restart": false,
"custom_data": {
"map": "forest",
"mode": "ctf"
}
},
"matchmaking": {
"teams": 2,
"players_per_team": 2,
"min_players_per_team": 1,
"min_teams": 2,
"team_composition": {
"monsters": {
"boss": 1
},
"hunters": {
"medic": 1,
"assault": 2
}
},
"use_version_from_state": false,
"timeout": 120,
"max_party_size": 4,
"rules": [
{
"type": "difference",
"field": "mmr",
"max_difference": 200
}
]
}
}
]
}Authorizations
Per-project server key, prefixed sk_live_. Full access to every
endpoint. Keep it on your backend: never ship it in a game binary.
Query Parameters
Maximum number of items to return.
Required range:
1 <= x <= 100Number of items to skip before collecting the result set.
Required range:
x >= 0Response
A page of queues.
Envelope fields shared by every list endpoint.