Retrieve a paginated list of supported charities
Copy
curl --request GET \
--url http://localhost:3003/v1/charitiesCopy
{
"data": {
"limit": 1,
"offset": 1,
"response": [
{
"address": "431 18th Street NW",
"btc_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"city": "Washington",
"country": "United States",
"enabled": true,
"eth_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"logo": "https://example.com/logo.png",
"name": "American Red Cross",
"organization_slug": "red-cross",
"sol_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
"state": "DC",
"swap_mode": "auto",
"tax_id": "53-0196605",
"website": "https://www.redcross.org",
"zip_code": "20006"
}
],
"total": 1,
"sort_by": "name"
},
"success": true,
"meta": "<unknown>"
}Charities
Retrieve a paginated list of supported charities
This endpoint returns a list of enabled charities with pagination support. Results can be sorted by various fields such as name, organization_slug, city, or country.
Query Parameters
limit(u16, required): Maximum number of charities to return. Maximum 100.offset(u16, required): Number of charities to skip.sort_by(String, optional): Field to sort by. Valid values: “name”, “organization_slug”, “city”, “country”. Defaults to “name”.
Returns
A paginated response containing:
response: Array of charity objectstotal: Total number of enabled charitieslimit: The limit used for this requestoffset: The offset used for this requestsort_by: The sort field used for this request
GET
/
v1
/
charities
Retrieve a paginated list of supported charities
Copy
curl --request GET \
--url http://localhost:3003/v1/charitiesCopy
{
"data": {
"limit": 1,
"offset": 1,
"response": [
{
"address": "431 18th Street NW",
"btc_address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
"city": "Washington",
"country": "United States",
"enabled": true,
"eth_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"logo": "https://example.com/logo.png",
"name": "American Red Cross",
"organization_slug": "red-cross",
"sol_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
"state": "DC",
"swap_mode": "auto",
"tax_id": "53-0196605",
"website": "https://www.redcross.org",
"zip_code": "20006"
}
],
"total": 1,
"sort_by": "name"
},
"success": true,
"meta": "<unknown>"
}Query Parameters
Maximum number of charities to return (required, max: 100)
Required range:
x >= 0Number of charities to skip (required)
Required range:
x >= 0Field to sort by: name, organization_slug, city, country (default: name)
Response
Successfully retrieved charities
⌘I