Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

We have also included an example file for you to experiment with.

Attachments

...

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 details of a specific ordera single order record.

Trades

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

  • GET /api/trade/{trade_ulid}: 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.

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

...