Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

We have Public API Documentation on 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.

  File Modified
No files shared here yet.

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.

User

  • 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 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 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 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.

Request and Response Formats

Requests

  • Headers:

    • Content-Type: application/json for endpoints accepting data.

    • Authorization: Bearer <API_KEY> for authenticated requests.

  • Body:

    • For endpoints that accept data (e.g., POST, PATCH), the request body must be in JSON format, containing the relevant attributes for the resource being created or updated.

Responses

  • Body:

    • All successful responses will return data in JSON format.

    • The structure of the response will depend on the endpoint but will typically include attributes of the resource(s) being retrieved or a confirmation of the action taken.

Authentication for API Access

The API will employ a secure authentication mechanism using API keys to ensure that only authorized users can access the API. The authentication process will be as follows:

  • API Key Generation:

    • API keys can be generated through the user's account settings in the platform's UI. Keys can be issued at a company level or for individual users, depending on the required scope of access.

  • API Key Usage:

    • To authenticate an API request, the user must include their API key in the Authorization header as a bearer token.

  • Security Measures:

    • All API requests must be sent over HTTPS to ensure the security of data in transit.

    • Rate limiting and other security measures are implemented to protect the API from abuse and to ensure the stability of the platform.

  • No labels

This material has been prepared by TOD Markets Pty Ltd (ABN 32 675 980 604) (TOD Markets, 'us' or 'we').

TOD Markets is a corporate authorised representative (CAR 001311315) of 62 Consulting Pty Limited (ABN 88 664 809 303) (AFSL 548573) (62C).

The material is for general information only and is not an offer for the purchase or sale of any financial product or service. The material has been prepared for investors who qualify as wholesale clients under sections 761G of the Corporations Act or to any other person who is not required to be given a regulated disclosure document under the Corporations Act. The material is not intended to provide you with financial or tax advice and does not take into account your objectives, financial situation or needs. Although we believe that the material is correct, no warranty of accuracy, reliability or completeness is given, except for liability under statute which cannot be excluded. Please note that past performance may not be indicative of future performance and that no guarantee of performance, the return of capital or a particular rate of return is given by 62C, #548573, any of their related body corporates or any other person. To the maximum extent possible, 62C, #548573, their related body corporates or any other person do not accept any liability for any statement in this material.