Request a report

POST

reports

cURL

curl --request POST \
  --url https://api.nxos.io/v1/reports \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "ACCOUNT_STATEMENT",
  "format": "PDF",
  "from": "2026-09-01",
  "to": "2026-09-30",
  "currency": "USD"
}
'

import requests

url = "https://api.nxos.io/v1/reports"

payload = {
    "type": "ACCOUNT_STATEMENT",
    "format": "PDF",
    "from": "2026-09-01",
    "to": "2026-09-30",
    "currency": "USD"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'ACCOUNT_STATEMENT',
    format: 'PDF',
    from: '2026-09-01',
    to: '2026-09-30',
    currency: 'USD'
  })
};

fetch('https://api.nxos.io/v1/reports', 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.nxos.io/v1/reports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'ACCOUNT_STATEMENT',
    'format' => 'PDF',
    'from' => '2026-09-01',
    'to' => '2026-09-30',
    'currency' => 'USD'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nxos.io/v1/reports"

	payload := strings.NewReader("{\n  \"type\": \"ACCOUNT_STATEMENT\",\n  \"format\": \"PDF\",\n  \"from\": \"2026-09-01\",\n  \"to\": \"2026-09-30\",\n  \"currency\": \"USD\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nxos.io/v1/reports")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"ACCOUNT_STATEMENT\",\n  \"format\": \"PDF\",\n  \"from\": \"2026-09-01\",\n  \"to\": \"2026-09-30\",\n  \"currency\": \"USD\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nxos.io/v1/reports")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"ACCOUNT_STATEMENT\",\n  \"format\": \"PDF\",\n  \"from\": \"2026-09-01\",\n  \"to\": \"2026-09-30\",\n  \"currency\": \"USD\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "report",
  "reportId": "rpt_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "type": "ACCOUNT_STATEMENT",
  "format": "PDF",
  "status": "READY",
  "from": "2026-09-01",
  "to": "2026-09-30",
  "asOf": null,
  "currency": "USD",
  "fileName": "NXOS - Account statement - 2026-09 - Acme Ltd.pdf",
  "sizeBytes": 48211,
  "createdAt": "2026-10-01T09:12:44.000Z",
  "readyAt": "2026-10-01T09:12:51.000Z"
}

Headers

Authorization

string

required

Bearer token. Format: Bearer <api_key>

Idempotency-Key

string

Unique key per logical operation. UUID v4 recommended. Max 255 characters.

Body

application/json

Option 1
Option 2
Option 3

A report request, discriminated by type.

type

enum<string>

required

ACCOUNT_STATEMENT or TRANSACTION_STATEMENT.

Available options:

ACCOUNT_STATEMENT,

TRANSACTION_STATEMENT

format

enum<string>

required

File format.

Available options:

PDF,

CSV

from

string

required

First day covered (YYYY-MM-DD, UTC). No earlier than 2024-01-01.

string

required

Last day covered, inclusive (YYYY-MM-DD, UTC). At most 366 days after from; a range reaching today runs up to now.

currency

string | null

Asset code of the one currency to cover. Omit or pass null for every currency.

Response

The request has succeeded and a new resource has been created as a result.

A report of your organization: a statement, a balance certificate or a bank confirmation letter.

object

enum<string>

required

Object type. Always report.

Available options:

report

reportId

string

required

Report identifier.

type

enum<string>

required

The kind of document.

Available options:

ACCOUNT_STATEMENT,

TRANSACTION_STATEMENT,

BALANCE_CERTIFICATE,

BANK_CONFIRMATION_LETTER

format

enum<string>

required

File format.

Available options:

PDF,

CSV

status

enum<string>

required

Where the report stands. Download it once READY.

Available options:

PENDING,

PROCESSING,

READY,

FAILED

from

string | null

required

First day covered (YYYY-MM-DD, UTC) for a statement; null otherwise.

string | null

required

Last day covered, inclusive (YYYY-MM-DD, UTC) for a statement; null otherwise.

asOf

string | null

required

The day whose closing balances a certificate states (YYYY-MM-DD, UTC); null for other reports.

currency

string | null

required

The one currency covered, or null when the report covers every currency.

fileName

string | null

required

File name, once READY.

sizeBytes

integer<int32> | null

required

File size in bytes, once READY.

createdAt

string

required

When the report was requested.

readyAt

string | null

required

When the file became available. null until READY.

cURL

curl --request POST \
  --url https://api.nxos.io/v1/reports \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "ACCOUNT_STATEMENT",
  "format": "PDF",
  "from": "2026-09-01",
  "to": "2026-09-30",
  "currency": "USD"
}
'

import requests

url = "https://api.nxos.io/v1/reports"

payload = {
    "type": "ACCOUNT_STATEMENT",
    "format": "PDF",
    "from": "2026-09-01",
    "to": "2026-09-30",
    "currency": "USD"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'ACCOUNT_STATEMENT',
    format: 'PDF',
    from: '2026-09-01',
    to: '2026-09-30',
    currency: 'USD'
  })
};

fetch('https://api.nxos.io/v1/reports', 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.nxos.io/v1/reports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'ACCOUNT_STATEMENT',
    'format' => 'PDF',
    'from' => '2026-09-01',
    'to' => '2026-09-30',
    'currency' => 'USD'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nxos.io/v1/reports"

	payload := strings.NewReader("{\n  \"type\": \"ACCOUNT_STATEMENT\",\n  \"format\": \"PDF\",\n  \"from\": \"2026-09-01\",\n  \"to\": \"2026-09-30\",\n  \"currency\": \"USD\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nxos.io/v1/reports")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"ACCOUNT_STATEMENT\",\n  \"format\": \"PDF\",\n  \"from\": \"2026-09-01\",\n  \"to\": \"2026-09-30\",\n  \"currency\": \"USD\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nxos.io/v1/reports")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"ACCOUNT_STATEMENT\",\n  \"format\": \"PDF\",\n  \"from\": \"2026-09-01\",\n  \"to\": \"2026-09-30\",\n  \"currency\": \"USD\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "report",
  "reportId": "rpt_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "type": "ACCOUNT_STATEMENT",
  "format": "PDF",
  "status": "READY",
  "from": "2026-09-01",
  "to": "2026-09-30",
  "asOf": null,
  "currency": "USD",
  "fileName": "NXOS - Account statement - 2026-09 - Acme Ltd.pdf",
  "sizeBytes": 48211,
  "createdAt": "2026-10-01T09:12:44.000Z",
  "readyAt": "2026-10-01T09:12:51.000Z"
}

Overview

Setup

Move money

Track

Broker

Referrals

Testing

Request a report

Headers

Body

Response