Getting Started

Introduction

The cieTrade.net API allows you to perform "GET" or retrieval operations on many commonly used datasets that are part of the platform.  The  API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients that can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

https://api.cietrade.net/

HTTP Method and Authentication

cieTrade.net's current API version only provides support for GET methods used for retrieving data. Using GET method, you can get the list of resources or details of a particular instance of a resource. All cieTrade.net API calls are authenticated using an authorized UserID which is passed as parameters with the GET request URL, as well as a Bearer Token which needs to be provided in the authorization section of your BI tool or code call. The token can be found in your settings under "Integration" -> "Api Token" if your account has permissions to access cieTrade API. Below is an example in Postman of including the Bearer Token in your request.

To grant user access to the API: Go to Settings> Users & Roles, click on the user and check 'Can Access cieTrade API', then Save. The database owner or anyone with this checked can update other users. 

To grant user access to Regenerate API Token: Go to Settings> Users & Roles, click on Roles, click on the role you want to grant permission to and check 'Allow Generation of API Token', then Save. By default, only users set to the ADMIN role will have access. 

In the example below we are providing the UserID credential, UserID="ExampleUser@gmail.com" inside of the request link along with the endpoint specific parameters. The token has been included in the authorization section shown in the screenshot above.

For example, to get a list of customers (counterparties) you would use the following URL for "ListCounterparties"  

https://api.cietrade.net/ListAccounts?UserID=ExampleUser@gmail.com&Role=Customer

Response

Responses will be in the JSON format. For example a response to the "ListAccounts" API may appear as follows: Note this is just an sample. Please see ListAccounts for complete documentation on this endpoint.

{
    "AccountID" : 100123,
    "AccountName" : "Secondary Fiber Inc.",
    "Address1" : "1023 Commerce Street",
    "Address2" : "Suite 1023",
    "City" : "New London",
    "Region" : "CT",
    "PortalCode" : "10298",
    "Country" : "USA",  
    "StartDate" : "2024/09/02"	
}

API Call and Concurrent Rate Limits

API calls and execution concurrency are currently not limited. However, to provide better quality of service and availability to all the users this policy may change going forward with requests limited by total per day or by account.

If you would like more information on specific APIs, visit our help page here.