Overview
The Room-In-A-Name (RIAN) API allows you to extract data directly from FundApps to monitor the headroom of your active positions. When two or more instruments, such as a mini and a full-sized future, are aggregated, the API response provides the headroom for both instruments independently.
Please note that the RIAN feature is only available for production environments.
By integrating this API with your internal systems, such as an Order Management System (OMS), traders can instantly see how much they can trade before reaching a regulatory limit.
This article covers how to access the documentation and other important information.
Accessing the API Documentation
An API User type in FundApps is required to view the following technical specifications and available endpoints.
Open the API documentation at:
(company name)-api.fundapps.co/swagger.Select PL from the dropdown menu at the top-right of the page to access the Position Limits version of the API.
The following API Reference guide is also available.
Extracting Data
Use the following URL format to return the last available data date for your Shareholding Disclosure results: (company-name)-api.fundapps.co/v1/roominaname.
For Position Limits results, you can use the following URL format: (company-name)-api.fundapps.co/v1/positionlimits/noominaname/(yyyy-mm-dd).
Data Availability and Responses
Calendar Dates: The API will return a response for any requested calendar date.
Empty Responses: If the requested date does not match a date on which a position file was uploaded to FundApps, the API will return an empty response.