Gamification
Get leaderboard
Get leaderboard of the top ranking users in your school
Rate limit: Maximum 60 requests in a window of 1m.
POST
/
public
/
get-school-leaderboard
Get leaderboard
curl --request POST \
--url https://backend.codedamn.com/api/public/get-school-leaderboard \
--header 'Content-Type: application/json' \
--data '
{
"data": [
{
"data": {
"data": {
"fermionSchoolId": "<string>",
"limit": 250
}
}
}
]
}
'import requests
url = "https://backend.codedamn.com/api/public/get-school-leaderboard"
payload = { "data": [{ "data": { "data": {
"fermionSchoolId": "<string>",
"limit": 250
} } }] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({data: [{data: {data: {fermionSchoolId: '<string>', limit: 250}}}]})
};
fetch('https://backend.codedamn.com/api/public/get-school-leaderboard', 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://backend.codedamn.com/api/public/get-school-leaderboard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'data' => [
'data' => [
'fermionSchoolId' => '<string>',
'limit' => 250
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backend.codedamn.com/api/public/get-school-leaderboard"
payload := strings.NewReader("{\n \"data\": [\n {\n \"data\": {\n \"data\": {\n \"fermionSchoolId\": \"<string>\",\n \"limit\": 250\n }\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backend.codedamn.com/api/public/get-school-leaderboard")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"data\": {\n \"data\": {\n \"fermionSchoolId\": \"<string>\",\n \"limit\": 250\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.codedamn.com/api/public/get-school-leaderboard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"data\": {\n \"data\": {\n \"fermionSchoolId\": \"<string>\",\n \"limit\": 250\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"output": {
"status": "ok",
"data": {
"leaderboardUsers": [
{
"rank": 250,
"xpTotal": 123,
"xpDeltaInPeriod": 123,
"fermionUserId": "<string>",
"saasUserId": "<string>",
"userCreatedAtIso": "2023-11-07T05:31:56Z",
"name": "<string>",
"username": "<string>",
"profilePicUrl": "<string>"
}
]
}
}
}
]Previous
Get User Streak Data Retrieves streak data for a given user identifier
Authentication with the "FERMION-API-KEY" header is required to use this endpoint.
Rate limit: Maximum 360 requests in a window of 1m.
Next
⌘I
Get leaderboard
curl --request POST \
--url https://backend.codedamn.com/api/public/get-school-leaderboard \
--header 'Content-Type: application/json' \
--data '
{
"data": [
{
"data": {
"data": {
"fermionSchoolId": "<string>",
"limit": 250
}
}
}
]
}
'import requests
url = "https://backend.codedamn.com/api/public/get-school-leaderboard"
payload = { "data": [{ "data": { "data": {
"fermionSchoolId": "<string>",
"limit": 250
} } }] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({data: [{data: {data: {fermionSchoolId: '<string>', limit: 250}}}]})
};
fetch('https://backend.codedamn.com/api/public/get-school-leaderboard', 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://backend.codedamn.com/api/public/get-school-leaderboard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'data' => [
'data' => [
'fermionSchoolId' => '<string>',
'limit' => 250
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backend.codedamn.com/api/public/get-school-leaderboard"
payload := strings.NewReader("{\n \"data\": [\n {\n \"data\": {\n \"data\": {\n \"fermionSchoolId\": \"<string>\",\n \"limit\": 250\n }\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backend.codedamn.com/api/public/get-school-leaderboard")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"data\": {\n \"data\": {\n \"fermionSchoolId\": \"<string>\",\n \"limit\": 250\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.codedamn.com/api/public/get-school-leaderboard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"data\": {\n \"data\": {\n \"fermionSchoolId\": \"<string>\",\n \"limit\": 250\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"output": {
"status": "ok",
"data": {
"leaderboardUsers": [
{
"rank": 250,
"xpTotal": 123,
"xpDeltaInPeriod": 123,
"fermionUserId": "<string>",
"saasUserId": "<string>",
"userCreatedAtIso": "2023-11-07T05:31:56Z",
"name": "<string>",
"username": "<string>",
"profilePicUrl": "<string>"
}
]
}
}
}
]