Credit Facilities

The credit API gives you access to granular information pertaining to your credit facility held with Alpha. The GET credit_facilities endpoint can be used as part of the trade execution flows to check limits, but also independently to connect to any proprietary software or third-party applications.

Alpha offers Modular credit capabilities, allowing our clients to take advantage of different credit terms based on currency pairs and products. This is visually represented below (one facility can have many terms).

Providing the EntityID parameter allows you to retrieve a facility on a specific entity.

The API provides a view of your facility data including limits, utilisation, available balance, tenor, margin call terms and overall mark-to-market (MTM) position.

Within your credit facility you may have multiple terms, each with individual features. The TermID for all terms on the facility will be returned as part of the response.

To retrieve term information use the GET credit_terms endpoint (more details below).

For inquiries about increasing your credit facility or adding new terms, contact [email protected]

---

Credit Terms

The GET credit_term endpoint provides detailed insights into the specifics of each credit term within your credit facility.

You will need to pass the EntityID and FacilityID into the request. This will return detailed information on all terms on your facility. To filter you can pass the additional Currency and TermID parameters. To retrieve the relevant TermID use the GET credit_facilities endpoint.

Each term is uniquely tied to a particular set of available currencies, permitted tenors, limits and initial margin and variation margin obligations. You can leverage this service to verify your credit limit before initiating trades or following the booking of a forward contract to gain real-time updates on MTM and available facility balances.

---

Credit Letter

Obtain a copy of your official credit agreement issued by Alpha, outlining the terms and conditions of your credit arrangement by calling the GET credit_letter endpoint.

To get the credit letter for a specific entity you will need to pass the EntityID in the request. If no EntityID is provided all credit letters will be returned.

You can retrieve your relevant EntityID by calling the GET EntityID endpoint (coming soon).

---

MTM Reporting

Programmatically access your mark-to-market position for all trades executed through our platform.

Retrieve point-in-time valuations based on open positions on a specified date (required field):

By trade, using the GET v1/credit-facilities/mtm/trade endpoint.

By currency pair, using the GET credit-facilities/mtm/currency-pair endpoint

Customise your query by including parameters such as TermID, BuyCurrencies, SellCurrencies, SpecifiedCurrency (convert your MTM report into a currency of choice) and TradeType, to refine your search criteria effectively.

In the absence of additional parameters, the system will automatically return all mark-to-market positions for the designated date.