Guides

Reports APIs

Reports APIs are designed to monitor and report user account activity. They provide functionalities for retrieving reality check summaries, generating account statements, and subscribing to real-time transaction notifications.

These APIs are essential for ensuring regulatory compliance and giving clients up-to-date insights into their trading activities and account status.

#

API Name

Description

Send

Subscribe

Scope

1

Reality Check

Retrieves a summary of the client’s trades and account status for the Reality Check feature.

This includes the time elapsed since the session began and the associated profit/loss.

Read, Trading Information

2

Statement

Retrieves a summary of account transactions according to the specified search criteria.

Read, Trading Information

3

Transactions Stream

Subscribes to real-time transaction notifications.

Read, Trading Information