Request Challenge

Request a sign-in challenge for wallet authentication

POST /auth/challenge

Request authentication challenge

cURL

curl --request POST \
  --url https://api.jup.ag/trigger/v2/auth/challenge \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "walletPubkey": "BQ72nSv9f3PRyRKCBnHLVrerrv37CYTHm5h3s9VSGQDV",
  "type": "message"
}
'

import requests

url = "https://api.jup.ag/trigger/v2/auth/challenge"

payload = {
    "walletPubkey": "BQ72nSv9f3PRyRKCBnHLVrerrv37CYTHm5h3s9VSGQDV",
    "type": "message"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({walletPubkey: 'BQ72nSv9f3PRyRKCBnHLVrerrv37CYTHm5h3s9VSGQDV', type: 'message'})
};

fetch('https://api.jup.ag/trigger/v2/auth/challenge', 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/trigger/v2/auth/challenge",
  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([
    'walletPubkey' => 'BQ72nSv9f3PRyRKCBnHLVrerrv37CYTHm5h3s9VSGQDV',
    'type' => 'message'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jup.ag/trigger/v2/auth/challenge"

	payload := strings.NewReader("{\n  \"walletPubkey\": \"BQ72nSv9f3PRyRKCBnHLVrerrv37CYTHm5h3s9VSGQDV\",\n  \"type\": \"message\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	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://api.jup.ag/trigger/v2/auth/challenge")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"walletPubkey\": \"BQ72nSv9f3PRyRKCBnHLVrerrv37CYTHm5h3s9VSGQDV\",\n  \"type\": \"message\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jup.ag/trigger/v2/auth/challenge")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"walletPubkey\": \"BQ72nSv9f3PRyRKCBnHLVrerrv37CYTHm5h3s9VSGQDV\",\n  \"type\": \"message\"\n}"

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

200

{
  "type": "message",
  "challenge": "Sign this message to authenticate with Jupiter Trigger Order API: abc123..."
}

{
  "error": "<string>",
  "details": {}
}

Authorizations

x-api-key · string · header · required

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

Body

application/json

walletPubkey · string · required

Your Solana wallet public key

type · enum<string> · required

Challenge type. Use transaction for hardware wallets.

Available options: message, transaction

Response

200

application/json

Challenge for wallet signing

Option 1

Option 2

type · enum<string> · required

Available options: message

challenge · string · required

Message to sign