Skip to main content
GET
/
statements
/
export
Export statements roster as CSV
curl --request GET \
  --url https://api.royalti.io/statements/export \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/statements/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/statements/export', 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.royalti.io/statements/export",
  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: Bearer <token>"
  ],
]);

$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.royalti.io/statements/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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.royalti.io/statements/export")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/statements/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
"<string>"
{
  "status": "error",
  "message": "Unauthorized"
}

ā€‹
Description

Export statements roster (CSV) Streaming CSV sibling of GET /statements ā€” same admin guard and the same unpaginated readRoster query, streamed via fast-csv instead of a JSON envelope. Registered at /export (not nested under /users/*) so it can never be swallowed by a param route. Object/array fields (flags, breakdownSnapshot, deductionsSnapshot, statusHistory) are JSON-stringified per CSV cell. Authorization:
  • Required role: admin or higher

ā€‹
Code Examples

const response = await fetch('https://api.royalti.io/statements/export', {
  method: 'GET',
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
  'https://api.royalti.io/statements/export',
)

data = response.json()
print(data)

curl -X GET https://api.royalti.io/statements/export \

Authorizations

ā€‹
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

ā€‹
periodStart
string<date>

Provide together with periodEnd, or omit both for all periods.

ā€‹
periodEnd
string<date>

Response

CSV stream of the statements roster.

The response is of type file.