Content Comparison

...

We have detailed Public API Documentation on hosted by Postman! Postman is a common tool for building, testing and writing documentation for APIs.

Example Spreadsheet

We have also included an example file for you to experiment with. Historic versions are listed here, but you should download the latest version you see in this list.

...

Getting your API key

Visit your user profile using the top right user menu.

...

Then scroll to the bottom of the profile page to generate a new API Key:

...

Be sure to copy this API key into your system (excel or custom application) and don’t share it with anyone!

...

Current API Endpoints

Our API collection provides a range of endpoints corresponding to different resources and functionalities within the platform. The following are currently available.

...

• GET /user: returns the user, confirming that the API key works and who it is for.

...

Asset & Price Data

• GET /api/assets: Retrieve a list of available markets.assets

• GET /api/assets/prices: Retrieve detailed information about a specific market.

• GET /api/assets/close: Retrieve the recent close price of assets

Orders

• GET /api/orders: Retrieve a list of the user's orders.collection of company orders matching filter parameters

• POST /api/order: Place a new order.

• GET /api/orders/{order_ULID}: Retrieve a single order record.

Trades

• GET /api/trades: Retrieves a collection of company trades matching filter parameters

• GET /api/trade/{trade_ulid}: Retrieve details of a specific order: Retrieve a single trade record.

Market Information

• GET /api/market/trades: Retrieve the data for all trades by all companies on the market for up to 24 hours.

Company

• GET /api/counterparties: Retrieve a list of all of your existing counterparty connection (and their ULIDs) as well as a list of all other active participants who are not yet connected.

...

Detailed Documentation

We have detailed Public API Documentation on Postman! Postman is a common tool for building, testing and writing documentation for APIs.

Request and Response Formats

...