curl --request GET \
--url https://persephone.superform.xyz/v1/providers \
--header 'SF-API-KEY: <api-key>'import requests
url = "https://persephone.superform.xyz/v1/providers"
headers = {"SF-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'SF-API-KEY': '<api-key>'}};
fetch('https://persephone.superform.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://persephone.superform.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 => [
"SF-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://persephone.superform.xyz/v1/providers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("SF-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://persephone.superform.xyz/v1/providers")
.header("SF-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://persephone.superform.xyz/v1/providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["SF-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"providers": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"provider_type": "protocol",
"category": [
"<string>"
],
"chain_ids": [
"<string>"
],
"is_hidden": true,
"vanity_url": "morpho-blue",
"num_vaults": "<string>",
"tagline": "<string>",
"status_message": "<string>",
"metadata": {
"audits": [
{
"date": "2023-11-07T05:31:56Z",
"url": "<string>",
"auditor": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"graphics": {
"icon": "<string>",
"header": "<string>",
"watermark": "<string>"
},
"links": {
"discord": "<string>",
"documentation": "<string>",
"github": "<string>",
"medium": "<string>",
"telegram": "<string>",
"twitter": "<string>",
"website": "<string>"
}
},
"deployers": [
{
"address": "<string>",
"name": "<string>",
"is_verified": true,
"admin_status": "approved",
"created_at": "<string>"
}
],
"users": [
{
"address": "<string>",
"name": "<string>",
"role": "<string>"
}
],
"stats_basic": {
"tvl_total": 123,
"tvl_superform": 123,
"tvl_total_change_day": 123,
"tvl_total_change_week": 123,
"tvl_total_change_month": 123,
"tvl_total_change_year": 123,
"tvl_total_change_all_time": 123,
"tvl_superform_change_day": 123,
"tvl_superform_change_week": 123,
"tvl_superform_change_month": 123,
"tvl_superform_change_year": 123,
"tvl_superform_change_all_time": 123
},
"created_at": "2023-11-07T05:31:56Z",
"admin_status": "approved",
"auto_list_vaults": false,
"slug": "morpho-blue",
"chains": [
{
"chain_id": "<string>",
"name": "<string>",
"icon": "<string>",
"is_l1": true,
"rpcs": [
"<string>"
],
"explorers": [
"<string>"
],
"currency_name": "<string>",
"currency_symbol": "<string>",
"currency_icon": "<string>",
"currency_decimals": 123,
"currency_min_gas": "<string>"
}
],
"highest_apy_day": 123,
"highest_apy_week": 123,
"highest_apy_month": 123,
"highest_apy_year": 123
}
],
"providers_summary": [
{
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"type": "<string>",
"description": "<string>",
"admin_status": "<string>",
"is_hidden": true,
"slug": "<string>",
"categories": [
"<string>"
],
"tvl_total": 123,
"num_vaults": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Get All Providers
Lists providers. Filters: q (substring match on name/categories), category[], include_hidden (auth-gated). Sort: tvl_total | name | num_vaults (default tvl_total desc). Pass fields=summary to receive the slim ApiProviderListItem shape; otherwise the existing fat common.Provider shape is returned for back-compat.
curl --request GET \
--url https://persephone.superform.xyz/v1/providers \
--header 'SF-API-KEY: <api-key>'import requests
url = "https://persephone.superform.xyz/v1/providers"
headers = {"SF-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'SF-API-KEY': '<api-key>'}};
fetch('https://persephone.superform.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://persephone.superform.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 => [
"SF-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://persephone.superform.xyz/v1/providers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("SF-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://persephone.superform.xyz/v1/providers")
.header("SF-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://persephone.superform.xyz/v1/providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["SF-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"providers": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"provider_type": "protocol",
"category": [
"<string>"
],
"chain_ids": [
"<string>"
],
"is_hidden": true,
"vanity_url": "morpho-blue",
"num_vaults": "<string>",
"tagline": "<string>",
"status_message": "<string>",
"metadata": {
"audits": [
{
"date": "2023-11-07T05:31:56Z",
"url": "<string>",
"auditor": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"graphics": {
"icon": "<string>",
"header": "<string>",
"watermark": "<string>"
},
"links": {
"discord": "<string>",
"documentation": "<string>",
"github": "<string>",
"medium": "<string>",
"telegram": "<string>",
"twitter": "<string>",
"website": "<string>"
}
},
"deployers": [
{
"address": "<string>",
"name": "<string>",
"is_verified": true,
"admin_status": "approved",
"created_at": "<string>"
}
],
"users": [
{
"address": "<string>",
"name": "<string>",
"role": "<string>"
}
],
"stats_basic": {
"tvl_total": 123,
"tvl_superform": 123,
"tvl_total_change_day": 123,
"tvl_total_change_week": 123,
"tvl_total_change_month": 123,
"tvl_total_change_year": 123,
"tvl_total_change_all_time": 123,
"tvl_superform_change_day": 123,
"tvl_superform_change_week": 123,
"tvl_superform_change_month": 123,
"tvl_superform_change_year": 123,
"tvl_superform_change_all_time": 123
},
"created_at": "2023-11-07T05:31:56Z",
"admin_status": "approved",
"auto_list_vaults": false,
"slug": "morpho-blue",
"chains": [
{
"chain_id": "<string>",
"name": "<string>",
"icon": "<string>",
"is_l1": true,
"rpcs": [
"<string>"
],
"explorers": [
"<string>"
],
"currency_name": "<string>",
"currency_symbol": "<string>",
"currency_icon": "<string>",
"currency_decimals": 123,
"currency_min_gas": "<string>"
}
],
"highest_apy_day": 123,
"highest_apy_week": 123,
"highest_apy_month": 123,
"highest_apy_year": 123
}
],
"providers_summary": [
{
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"type": "<string>",
"description": "<string>",
"admin_status": "<string>",
"is_hidden": true,
"slug": "<string>",
"categories": [
"<string>"
],
"tvl_total": 123,
"num_vaults": "<string>"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
API key required for authentication. Use the value {{v2_api_key}} in Postman.
Query Parameters
Pass 'summary' to receive the slim ApiProviderListItem shape in providers_summary instead of the fat common.Provider shape in providers.
Sort key. One of: tvl_total, name, num_vaults. Default: tvl_total.
Sort direction. asc or desc. Default: desc.
Substring match against provider name and categories (case-insensitive).
Category filter. Repeat the param to OR multiple categories.
When true, also returns hidden/unapproved providers. Requires JWT + superadmin or provider admin.
