# API Reference Guide

***

GlobalTopUp APIs are completely RESTful, and all our responses are returned in JSON.

## **Test and Live Mode API Keys**

You can use GlobalTopUp APIs in two modes, Test and Live. The API keys are different for each mode. Know about generating API Keys.

## Live Environment

* <https://services.globaltopup.in/api/v1>

## Test Environment

* [https://uatservices.globaltopup.in/api/v1](https://services.globaltopup.in/api/v1)

## API Gateway URL

The GlobalTopUp API Gateway URL is <https://services.globaltopup.in/api/v1>. You need to include this before each API endpoint to make API calls.

### Example

Use the URL `https://services.globaltopup.in/api/v1/utility/operators` to access payment resources.

### Versioning

All GlobalTopUp APIs are backwards-compatible. If an API or its parameters are deprecated, we add a warning note for the same for a specific period of time.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.globaltopup.in/introduction/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.