Skip to main content

Getting Started

Welcome to TradeStack API documentation! This guide will help you get up and running with our API, whether you're integrating for the first time or looking to expand your implementation.

What is TradeStack?​

TradeStack is a comprehensive trading platform API that enables developers to build powerful applications for managing customers, processing orders, tracking inventory, and streamlining trading operations. Our RESTful API provides programmatic access to all core TradeStack functionality.

Prerequisites​

Before you begin, you'll need:

  • TradeStack Account - Sign up at TradeStack Console to get access
  • API Credentials - Generate your Token when you login, preferably via postman
  • Development Environment - Any environment capable of making HTTP requests
  • Basic Knowledge - Familiarity with RESTful APIs and JSON

Authentication​

All TradeStack API requests require authentication using API keys. Include your API key in the request header:

Authorization: Bearer YOUR_TOKEN

Keep your API keys secure and never expose them in client-side code or public repositories.

Base URL​

All API requests should be made to:

https://uat.api.ibuqa.io/api/

Making Your First Request​

Here's a simple example to verify your API connection by fetching your account information:

curl -X GET https://uat.api.ibuqa.io/api/users/me/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

A successful response will return your account details in JSON format.

API Structure​

TradeStack API is organized into logical domains, each accessible through the API Reference menu in the top navigation. Our main domains include:

  • Customers - Manage customer records, contacts, and relationships
  • Orders - Create, update, and track orders throughout their lifecycle
  • Products - Handle product catalogs, pricing, and inventory
  • Invoices - Generate and manage invoicing and billing
  • Payments - Process payments and track transaction history
  • Reporting - Access analytics and generate business reports

Each domain contains detailed endpoint documentation including request/response examples, parameters, and error codes.

Response Format​

All API responses are returned in JSON format. Successful requests return a 2xx status code along with the requested data:

{
  "success": true,
  "data": {
    // Response data here
  }
}

Error responses include a 4xx or 5xx status code with details:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Description of the error"
  }
}

Pagination​

List endpoints support pagination using page and size parameters:

GET /customers?size=50&page=1

Responses include pagination metadata to help navigate through results.

Support and Resources​

  • API Reference - Comprehensive endpoint documentation (use the top navigation menu)
  • Code Examples - Sample implementations for common use cases

Next Steps​

Ready to dive deeper? Here's what to explore next:

  1. Browse the API Reference - Click on any domain in the top navigation to explore available endpoints
  2. Try the Customers API - A great starting point for most integrations

We're excited to see what you'll build with TradeStack API. Happy coding!