API Overview

Base URL

https://api.shoal.xyz/v1

All requests require Bearer token authentication:

Authorization: Bearer YOUR_API_KEY

List endpoints support pagination:

Parameter	Type	Default	Description
`limit`	integer	50	Number of results to return
`offset`	integer	0	Pagination offset

{
  "limit": 50,
  "offset": 0,
  "data": [...]
}

{
  "error": "Error message"
}

Code	Description
`200`	Success
`400`	Bad Request - Missing required parameter
`401`	Unauthorized - Invalid or missing API key
`500`	Internal Server Error

⌘I