Get Leaderboards

Get leaderboards

curl --request GET \
  --url https://api.jup.ag/prediction/v1/leaderboards \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jup.ag/prediction/v1/leaderboards', 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.jup.ag/prediction/v1/leaderboards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-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.jup.ag/prediction/v1/leaderboards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.jup.ag/prediction/v1/leaderboards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "ownerPubkey": "<string>",
      "realizedPnlUsd": "<string>",
      "totalVolumeUsd": "<string>",
      "predictionsCount": 123,
      "correctPredictions": 123,
      "wrongPredictions": 123,
      "winRatePct": "<string>",
      "period": "<string>",
      "periodStart": "<string>",
      "periodEnd": "<string>"
    }
  ],
  "summary": {
    "all_time": {
      "totalVolumeUsd": "<string>",
      "predictionsCount": 123
    },
    "weekly": {
      "totalVolumeUsd": "<string>",
      "predictionsCount": 123
    },
    "monthly": {
      "totalVolumeUsd": "<string>",
      "predictionsCount": 123
    }
  }
}

GET

leaderboards

Get leaderboards

curl --request GET \
  --url https://api.jup.ag/prediction/v1/leaderboards \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jup.ag/prediction/v1/leaderboards', 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.jup.ag/prediction/v1/leaderboards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-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.jup.ag/prediction/v1/leaderboards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.jup.ag/prediction/v1/leaderboards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "ownerPubkey": "<string>",
      "realizedPnlUsd": "<string>",
      "totalVolumeUsd": "<string>",
      "predictionsCount": 123,
      "correctPredictions": 123,
      "wrongPredictions": 123,
      "winRatePct": "<string>",
      "period": "<string>",
      "periodStart": "<string>",
      "periodEnd": "<string>"
    }
  ],
  "summary": {
    "all_time": {
      "totalVolumeUsd": "<string>",
      "predictionsCount": 123
    },
    "weekly": {
      "totalVolumeUsd": "<string>",
      "predictionsCount": 123
    },
    "monthly": {
      "totalVolumeUsd": "<string>",
      "predictionsCount": 123
    }
  }
}

Authorizations

x-api-key

string

header

required

Get API key via https://developers.jup.ag/portal

Query Parameters

period

enum<string>

default:all_time

Ranking window: all_time, weekly or monthly.

Available options:

all_time,

weekly,

monthly

limit

integer

default:100

Maximum number of entries to return.

Required range: 1 <= x <= 100

metric

enum<string>

default:pnl

Ranking metric: pnl, volume or win_rate.

Available options:

pnl,

volume,

win_rate

Response

200 - application/json

Leaderboard entries

data

object[]

required

Show child attributes

summary

object

required

Show child attributes

Prediction

Data & Analytics

Guides

API Reference

Authorizations

Query Parameters

Response