> ## Documentation Index
> Fetch the complete documentation index at: https://telecomsxchange.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the TelecomsXChange API documentation

## What is it?

TCXC Programmable X APIs refers to communications service providers (CSPs)
utilizing application programming interfaces (APIs) to automate the core actions
for telecom wholesale buying and selling, such as interconnection, carrier
relations, market opportunity research, ticket escalation, communications,
traffic routing control, ratings and reviews, financial settlements for Voice ,
SMS and Virtual Numbers.

## Overview

Before you consume this API you must have a valid TelecomsXChange buyer or
seller account. If you do not already have one, you may signup
[here](https://www.telecomsxchange.com/).

## Authentication

Find below the two API authentication methods supported by TCXC, you may use any of them to authenticate to the API

## Digest Authentication

To authenticate using Digest Authentication, you need to pass on the following
information:

**Username**: \{TCXC Username} <br /> **Password**: \{TCXC API Key}

<Card title="For more information on Digest Authentication" icon="user-lock" href="https://en.wikipedia.org/wiki/Digest_access_authentication">
  Learn more
</Card>

## Signature Based Authentication

<Warning>
  This method is more secure, but not developer friendly and may not work with
  tools like Postman.
</Warning>

Each API access call must be authenticated. In this API , there are 3 (three)
HTTPS parameters are required to be supplied to verify the authenticity of the
API caller:

| Parameter Name | Value                                                                                             |
| -------------- | ------------------------------------------------------------------------------------------------- |
| `ts`           | current unix timestamp of the call                                                                |
| `api_login`    | your buyer login in TCXC                                                                          |
| `signature`    | signature of the request which is a SHA256 hash of the concatenated string of the controller name |

The API key is generated from TCXC portal under preferences option, TCXC buyer
login and the string value of the unxi timestamp associated with the request.

## Rate LIMIT

TCXC API rate limits your requests to a specified hourly value based on your account.

Contact us if you desire a higher rate limit. Users are also limited to a number
of requests per second. If you exceed either limit you will receive an HTTP 429
error.

| AUTHORIZATION | Digest Auth |
| ------------- | ----------- |
| **Username**  | \<username> |
| **Password**  | \<password> |