Turuq Open API

Getting Started

Welcome to the Turuq Open API documentation! The Turuq API allows authorized users programatic access to their account data in order to facilitate the integration of this data with other systems and service. The API is organized around REST standards. The API uses resource-oriented URLs and returns JSON-encoded responses. It uses standard HTTP response codes, authentication, and verbs.

Base URL

All API requests should be prefixed with our versioned base URL, the following URL is used for development:

https://dev-api.turuq.co/api/v1/

The production URL can be found within the Integrations tab under the Open API documentation.

What’s Next?

Before diving into the detailed endpoint reference, this guide will cover the foundational concepts you need to get up and running:

1. Authentication
   How to obtain and use API keys to securely call our endpoints.

2. Response Status Codes
   A breakdown of the HTTP status codes we use and what they mean.

3. Pagination
   Strategies for paging through large result sets.

4. Sorting & Filtering
   How to sort your results and apply filters (e.g. by date range, status, or other fields).

5. Rate Limits
   Understanding our rate-limiting policies to ensure your integration remains reliable.

Once you’ve mastered these core topics, head over to the API Reference for a full catalogue of endpoints and examples.