Providers
List providers
List the perps providers with their network, supported actions and a JSON Schema of the arguments each action takes.
GET
/
v1
/
providers
List all providers
curl --request GET \
--url https://perps.yield.xyz/v1/providers \
--header 'x-api-key: <api-key>'import requests
url = "https://perps.yield.xyz/v1/providers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://perps.yield.xyz/v1/providers', 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://perps.yield.xyz/v1/providers",
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://perps.yield.xyz/v1/providers"
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))
}HttpResponse<String> response = Unirest.get("https://perps.yield.xyz/v1/providers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://perps.yield.xyz/v1/providers")
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[
{
"id": "hyperliquid",
"name": "Hyperliquid",
"network": "hyperliquid",
"metadata": {
"description": "Hyperliquid is a high-performance L1 optimized for perpetual futures trading.",
"externalLink": "https://hyperliquid.xyz",
"logoURI": "https://assets.stakek.it/providers/hyperliquid.svg"
},
"supportedActions": [
"open",
"close",
"updateLeverage"
],
"argumentSchemas": {
"open": {
"type": "object",
"properties": {
"marketId": {
"type": "string",
"label": "Market"
},
"side": {
"enum": [
"long",
"short"
],
"label": "Side"
},
"leverage": {
"type": "number",
"label": "Leverage"
}
},
"required": [
"marketId",
"side",
"leverage"
]
}
}
}
]{
"statusCode": 401,
"timestamp": "2026-05-04T12:00:00.000Z",
"path": "/v1/actions",
"message": "Invalid API key",
"details": {
"message": "Invalid API key",
"code": "AUTH_INVALID_API_KEY"
}
}{
"statusCode": 429,
"timestamp": "2026-05-04T12:00:00.000Z",
"path": "/v1/actions",
"message": "Rate limit exceeded",
"details": {
"message": "Rate limit exceeded",
"code": "RATE_LIMIT_EXCEEDED",
"error": "Too Many Requests",
"retryAfter": 30
}
}Returns an array, not a paginated object.
supportedActions and argumentSchemas are the authoritative list of what a provider accepts; per-action arguments are summarized in Action arguments. Provider IDs are listed in Providers.Authorizations
Response
List of all providers
Provider identifier
Example:
"hyperliquid"
Provider name
Example:
"Hyperliquid"
Network the provider operates on
Example:
"hyperliquid"
Provider metadata (description, logo, links)
Show child attributes
Show child attributes
Supported action types
Available options:
open, close, updateLeverage, stopLoss, takeProfit, cancelOrder, editOrder, fund, withdraw, approveAgent, approveBuilderFee, updateMargin, setTpAndSl, setUnifiedAccount Example:
["open", "close", "updateLeverage"]
Argument schemas for each supported action (JSON Schema format)
Show child attributes
Show child attributes
Example:
{
"open": {
"type": "object",
"properties": {
"marketId": { "type": "string", "label": "Market" },
"side": {
"enum": ["long", "short"],
"label": "Side"
},
"leverage": { "type": "number", "label": "Leverage" }
},
"required": ["marketId", "side", "leverage"]
}
}
⌘I
List all providers
curl --request GET \
--url https://perps.yield.xyz/v1/providers \
--header 'x-api-key: <api-key>'import requests
url = "https://perps.yield.xyz/v1/providers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://perps.yield.xyz/v1/providers', 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://perps.yield.xyz/v1/providers",
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://perps.yield.xyz/v1/providers"
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))
}HttpResponse<String> response = Unirest.get("https://perps.yield.xyz/v1/providers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://perps.yield.xyz/v1/providers")
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[
{
"id": "hyperliquid",
"name": "Hyperliquid",
"network": "hyperliquid",
"metadata": {
"description": "Hyperliquid is a high-performance L1 optimized for perpetual futures trading.",
"externalLink": "https://hyperliquid.xyz",
"logoURI": "https://assets.stakek.it/providers/hyperliquid.svg"
},
"supportedActions": [
"open",
"close",
"updateLeverage"
],
"argumentSchemas": {
"open": {
"type": "object",
"properties": {
"marketId": {
"type": "string",
"label": "Market"
},
"side": {
"enum": [
"long",
"short"
],
"label": "Side"
},
"leverage": {
"type": "number",
"label": "Leverage"
}
},
"required": [
"marketId",
"side",
"leverage"
]
}
}
}
]{
"statusCode": 401,
"timestamp": "2026-05-04T12:00:00.000Z",
"path": "/v1/actions",
"message": "Invalid API key",
"details": {
"message": "Invalid API key",
"code": "AUTH_INVALID_API_KEY"
}
}{
"statusCode": 429,
"timestamp": "2026-05-04T12:00:00.000Z",
"path": "/v1/actions",
"message": "Rate limit exceeded",
"details": {
"message": "Rate limit exceeded",
"code": "RATE_LIMIT_EXCEEDED",
"error": "Too Many Requests",
"retryAfter": 30
}
}
