Skip to main content

​
Base URL

https://api.shoal.xyz/v1

​
Make Your First Request

cURL
curl -X GET "https://api.shoal.xyz/v1/organizations/all?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
Python
import requests

response = requests.get(
    "https://api.shoal.xyz/v1/organizations/all",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"limit": 10}
)
data = response.json()
JavaScript
const response = await fetch(
  "https://api.shoal.xyz/v1/organizations/all?limit=10",
  { headers: { Authorization: "Bearer YOUR_API_KEY" } }
);
const data = await response.json();

​
Response

{
  "limit": 10,
  "offset": 0,
  "data": [
    {
      "id": 1,
      "label": "Organization Name",
      "cover_image": "url",
      "aliases": ["Alias1", "Alias2"]
    }
  ]
}

​
Next Steps