List withdrawals
curl --request GET \
--url https://api.example.com/api/withdrawals/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/withdrawals/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/api/withdrawals/', 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://api.example.com/api/withdrawals/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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://api.example.com/api/withdrawals/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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://api.example.com/api/withdrawals/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/withdrawals/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"page": 1,
"page_size": 10,
"total_documents": 1,
"documents": [
{
"email": "use*@example.com",
"date": "May 2026",
"withdrawable_amount": "10.00",
"profit_split": "0.20"
}
],
"average_payout": "10.00"
}withdrawals
List withdrawals
List your firm’s withdrawals from the last 365 days, with optional filtering by payout month, account ID, or both.
GET
/
api
/
withdrawals
/
List withdrawals
curl --request GET \
--url https://api.example.com/api/withdrawals/ \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/api/withdrawals/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/api/withdrawals/', 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://api.example.com/api/withdrawals/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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://api.example.com/api/withdrawals/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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://api.example.com/api/withdrawals/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/withdrawals/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"page": 1,
"page_size": 10,
"total_documents": 1,
"documents": [
{
"email": "use*@example.com",
"date": "May 2026",
"withdrawable_amount": "10.00",
"profit_split": "0.20"
}
],
"average_payout": "10.00"
}Authorizations
Token-based authentication with required prefix "Token"
Query Parameters
Specific account ID to return withdrawals for.
Filter by month (ISO 8601 format) or "All"
Page number
Number of items per page
Response
List of withdrawals
Current 1-indexed page number.
Number of withdrawals returned per page.
Total withdrawals matching the filters.
Withdrawals returned for the requested page.
Show child attributes
Show child attributes
Average requested withdrawable amount across withdrawals from the last 365 days, scoped by account ID when provided; the optional month filter does not change this value.
Pattern:
^-?\d{0,10}(?:\.\d{0,2})?$