PegasusSwap

https://pegasusswap.com/api-docs
Admin
PegasusSwap is an instant cryptocurrency swap API that enables users to exchange digital assets...
Tokens:10,620
Snippets:47
Trust Score:7
Update:8 months ago
Show doc for...
Tokens:
Raw
### Initiate Transaction - Example Response JSON

Source: https://pegasusswap.com/api-docs/-initiate-transaction

An example of a successful JSON response when initiating a transaction. This illustrates the structure and typical values for swap details, coin information, addresses, and transaction status.

```JSON
{
  "type": {
    "typeSwap": 2
  },
  "pairs": {
    "deposit": {
      "coin": {
        "name": "BTC",
        "value": 0.00047,
        "network": "BTC",
        "fullName": ""
      },
      "address": "bc1qt3uurp5yjl0s9hpc834nkxx37f99hn5xfqt8x3",
      "memo": ""
    },
    "receive": {
      "coin": {
        "name": "XMR",
        "value": 0.37555349507259705,
        "network": "XMR",
        "fullName": ""
      },
      "address": "49ALvhFRnJm4n1JsBG2fiAcrpPXeGEUvrLCvUjXNr9TqLk74pmj9X7s9aprrzRNNWHUgRrYbmysN7Xs8UJijXumPTjV5WVb",
      "memo": ""
    }
  },
  "receiveTransaction": {
    "txId": "",
    "address": "",
    "receivedTime": "",
    "gettingInTheBlock": "",
    "amount": null,
    "confirmation": null,
    "fees": null
  },
  "fees": {
    "feeNodeDeposit": 0.00009912
  },
  "swapTime": {
    "end": "",
    "duration": "",
    "start": "1728573590155"
  },
  "orderNumber": "RBGTSM",
  "status": 3,
  "txId": "a5398b56b451405bbd2804839100e29709e6f79f993b1ba2e466e952ab7940e4",
  "riskScore": null,
  "receivedTime": "1726833220",
  "gettingInTheBlock": "1728574893",
  "confirmation": 5
}
```

--------------------------------

### Example Response for Currency Networks

Source: https://pegasusswap.com/api-docs/index

Shows the expected JSON response format when requesting currency networks, detailing available deposit and withdrawal network subNames.

```json
{
  "deposit": [
    {
      "subName": "ERC20"
    }
  ],
  "withdraws": [
    {
      "subName": "ERC20"
    }
  ]
}
```

--------------------------------

### Example Response for Available Currencies

Source: https://pegasusswap.com/api-docs/index

Illustrates the structure of a successful response when retrieving the list of available currencies, including pagination details and coin information with network support.

```json
{
  "pagination": {
    "pageCount": 52,
    "totalCount": 260
  },
  "depositCoins": [
    {
      "image": "example/USDT.png",
      "subName": "USDT",
      "name": "TetherUS",
      "networks": {
        "deposits": [
          {
            "subName": "TRX",
            "memoNeeded": true
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### GET /api/private/get-all-coins

Source: https://pegasusswap.com/api-docs/-available-currencies-list

Retrieves a paginated list of all available currencies for deposit or withdrawal, with options to filter by search term, method, specific coins, and networks.

```APIDOC
## GET /api/private/get-all-coins

### Description
This API endpoint provides a paginated list of all available currencies. You can filter the results by search term, method (deposit or withdrawal), specific coins, and networks.

### Method
GET

### Endpoint
https://api.pegasusswap.com/api/private/get-all-coins

### Parameters
#### Query Parameters
- **page** (number) - Optional - Current page number for pagination.
- **limit** (number) - Optional - Number of items per page.
- **search** (string) - Optional - Filter currencies by name.
- **method** (number) - Optional - Method 1 for deposit coins, Method 2 for withdrawal coins.
- **depositCoin** (string) - Optional - Filter by a specific deposit coin.
- **receiveCoin** (string) - Optional - Filter by a specific receive coin.
- **depositNetwork** (string) - Optional - Filter by a specific deposit network.
- **receiveNetwork** (string) - Optional - Filter by a specific receive network.

### Request Example
```
GET https://api.pegasusswap.com/api/private/get-all-coins?page=1&limit=5&method=1
```

### Response
#### Success Response (200)
- **pagination** (object) - Contains pagination details like `pageCount` and `totalCount`.
- **depositCoins** / **withdrawCoins** (array) - A list of currency objects. Each object contains:
  - **image** (string) - URL of the coin's image.
  - **subName** (string) - Abbreviated name of the coin.
  - **name** (string) - Full name of the coin.
  - **networks** (object) - Details about the coin's networks.
    - **deposits** / **withdraws** (array) - List of available networks for deposit or withdrawal.
      - **subName** (string) - Name of the network (e.g., 'TRX').
      - **memoNeeded** (boolean) - Indicates if an extra ID (memo) is required for transactions on this network.

#### Response Example
```json
{
  "pagination": {
    "pageCount": 52,
    "totalCount": 260
  },
  "depositCoins": [
    {
      "image": "example/USDT.png",
      "subName": "USDT",
      "name": "TetherUS",
      "networks": {
        "deposits": [
          {
            "subName": "TRX",
            "memoNeeded": true
          }
        ]
      }
    }
  ]
}
```
```

--------------------------------

### Retrieve Available Currencies List (GET)

Source: https://pegasusswap.com/api-docs/index

Fetches a paginated list of all available currencies for deposit or withdrawal. Supports filtering by page, limit, search term, method, and specific coins/networks.

```javascript
GET:
https://api.pegasusswap.com/api/private/get-all-coins?page=1&limit=5&method=1
```

--------------------------------

### Retrieve Currency Networks (GET)

Source: https://pegasusswap.com/api-docs/index

Retrieves the deposit and withdrawal networks associated with a specific currency. Requires the 'coin' parameter to identify the currency.

```javascript
GET:
https://api.pegasusswap.com/api/private/get-coin-network?coin=eth
```

--------------------------------

### GET /api/private/exchange-coin

Source: https://pegasusswap.com/api-docs/index

This API endpoint provides the amount the user will receive, the current swap rate, and other details for a given swap pair.

```APIDOC
## GET /api/private/exchange-coin

### Description
This API endpoint provides the amount the user will receive, the current swap rate, and other details for a given swap pair.

### Method
GET

### Endpoint
https://api.pegasusswap.com/api/private/exchange-coin

### Parameters
#### Query Parameters
- **amount** (string) - Required - Amount of currency you are going to send or get
- **coinFrom** (string) - Required - Currency to swap from
- **coinTo** (string) - Required - Currency to swap to
- **networkFrom** (string) - Optional - Network to swap from
- **networkTo** (string) - Optional - Network to swap to
- **lastSource** (string) - Required - We transfer the last input where the data is entered, to the deposit input or the receive input ( for example deposit or receive)
- **typeSwap** (string) - Required - 1 - fixed 2 -float

### Request Example
```
GET https://api.pegasusswap.com/api/private/exchange-coin?amount=10&coinFrom=eth&coinTo=usdt&lastSource=deposit&typeSwap=1
```

### Response
#### Success Response (200)
- **pair** (string) - Swap pair
- **amount** (number) - Amount sent
- **exchangeRate** (number) - Swap rate
- **receive** (number) - Amount you will receive
- **minAmount** (number) - Min deposit
- **maxAmount** (number) - Max deposit

#### Response Example
```json
{
  "pair": "ETH_USDT",
  "amount": "10",
  "exchangeRate": 2462.1076313215262,
  "receive": 24008.541206617498,
  "minAmount": 0.03,
  "maxAmount": 2100
}
```
```

--------------------------------

### GET /api/private/get-coin-network

Source: https://pegasusswap.com/api-docs/index

Retrieves the deposit and withdrawal networks associated with a specific currency.

```APIDOC
## GET /api/private/get-coin-network

### Description
This API endpoint provides the deposit and withdrawal networks associated with a specific currency code.

### Method
GET

### Endpoint
`https://api.pegasusswap.com/api/private/get-coin-network`

### Parameters
#### Query Parameters
- **coin** (string) - Required - The currency code (e.g., 'eth', 'usdt'). This corresponds to the `subName` of a coin.

### Request Example
```
GET https://api.pegasusswap.com/api/private/get-coin-network?coin=eth
```

### Response
#### Success Response (200)
- **deposit** (array) - List of available deposit networks for the specified coin.
    - **subName** (string) - Name of the deposit network (e.g., 'ERC20').
- **withdraws** (array) - List of available withdrawal networks for the specified coin.
    - **subName** (string) - Name of the withdrawal network (e.g., 'ERC20').

#### Response Example
```json
{
  "deposit": [
    {
      "subName": "ERC20"
    }
  ],
  "withdraws": [
    {
      "subName": "ERC20"
    }
  ]
}
```
```

--------------------------------

### Retrieve Currency Networks - GET Request

Source: https://pegasusswap.com/api-docs/-retrieve-currency-networks

This endpoint retrieves the available deposit and withdraw networks for a given cryptocurrency. It requires a 'coin' parameter specifying the currency code.

```HTTP
GET: https://api.pegasusswap.com/api/private/get-coin-network?coin=eth
```

--------------------------------

### Initiate Transaction - Request Body Parameters

Source: https://pegasusswap.com/api-docs/-initiate-transaction

Defines the parameters required for initiating a transaction. This includes specifying the deposit and receive coins, amounts, networks, swap type, and refund address if applicable. The 'lastSource' parameter indicates whether the transaction is for deposit or receive.

```Markdown
Name| Type| Required or optional| Description  
---|---|---|---  
depositCoin| string| required| Coin from deposit  
depositAmount| number| required| Amount from deposit  
depositNetwork| string| required| Address from deposit  
receiveAddress| string| required| Address from receive  
receiveCoin| string| required| Coin from receive  
receiveNetwork| string| required| Network from receive  
typeSwap| number| required| 1 - fixed, 2 -float  
refundAddress| string| optional| Refund address  
memo| string| optional| If needed memo  
lastSource| string| required| Deposit or receive  
```

--------------------------------

### Initiate Transaction - POST API Request

Source: https://pegasusswap.com/api-docs/-initiate-transaction

This API endpoint creates a new transaction, generates an address for fund transfer, and returns the transaction details. It requires details about the deposit and receive coins, amounts, networks, and swap type. Optional parameters include a refund address and memo.

```HTTP
POST
https://api.pegasusswap.com/api/private/create-transaction
```

--------------------------------

### Initiate Transaction - Successful Response Fields

Source: https://pegasusswap.com/api-docs/-initiate-transaction

Details the structure of a successful response when initiating a transaction. It includes information about the swap type, coin pairs, deposit and receive addresses, transaction IDs, fees, swap times, and the overall status of the transaction.

```Markdown
Name| Type| Description  
---|---|---  
type| object| An object containing the type of swap (fixed or floating rate)  
typeSwap| number| A type of swap where 1 - Fixed, 2 - Float  
pairs| object| An object containing information about coin pairs for deposit and withdrawal  
deposit/receive| object| An object containing information about a coin for deposit and withdrawal  
coin| object| An object containing information out of a coin for deposit and withdrawal  
name| string| Coin name (eg BTC, XMR)  
value| number| The number of coins that will be sent or received  
network| string| The network in which the transaction takes place (eg ERC20, XMR)  
fullName| string| The full name of the coin  
address| string| Address to send or receive coins  
memo| string| Memo for transaction  
receiveTransaction| object| An object containing information about the received transaction  
txId| string| Receive transaction id  
address| string| Address to receive coins  
receivedTime| string| The time the transaction was received  
gettingInTheBlock| string| The time of receiving the first sending confirmation  
amount| number | null| Number of coins sending  
confirmation| number | null| Number of confirmations for the transaction for sending  
fees| number | null| Fees for sending funds  
fees| object| An object containing information about commissions  
feeNodeDeposit| number| Fees for deposit  
swapTime| object| An object containing the swap time  
end| string| Transaction completion time  
duration| string| Duration of the transaction  
start| string| Transaction start time  
orderNumber| string| The unique identifier of the transaction  
status| number| New - 9; Confirmation - 1; Exchanging - 3; Success - 4, 12; Overdue - 5; Error - 6; Pause - 10; Frozen - 11; Refund - 13  
txId| string| Deposit transaction id  
riskScore| number | null| Risk assessment for the transaction  
receivedTime| string| Deposit receiving time  
gettingInTheBlock| string| The time of receiving the first deposit confirmation  
confirmation| number | null| Number of confirmations for the transaction for deposit  
```

--------------------------------

### API Base URL and Authentication

Source: https://pegasusswap.com/api-docs/index

Information about the base API URL, protocol, and required headers for authentication.

```APIDOC
## API Base URL and Authentication

### Description
All requests should use the domain `https://api.pegasusswap.com` and must be executed using HTTPS.

### Headers
All endpoints require valid API credentials, which should be included in the headers:

```
Accept: application/json
Content-Type: application/json
x-api-public-key: {publicKey}
x-api-signature: {signature}
x-api-payload: {payload}
```

Where:
- `signature = hex(HMAC_SHA512(payload, key=api_secret))`
- `payload` is the exact API name of the request (e.g., `get-all-coins`, `get-coin-network`).
```

--------------------------------

### Initiate Transaction API

Source: https://pegasusswap.com/api-docs/-initiate-transaction

This API endpoint creates a new transaction, generates an address for fund transfer, and returns the transaction details.

```APIDOC
## POST /api/private/create-transaction

### Description
This API endpoint creates a new transaction, generates an address for fund transfer, and returns the transaction details.

### Method
POST

### Endpoint
https://api.pegasusswap.com/api/private/create-transaction

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **depositCoin** (string) - Required - Coin from deposit
- **depositAmount** (number) - Required - Amount from deposit
- **depositNetwork** (string) - Required - Address from deposit
- **receiveAddress** (string) - Required - Address from receive
- **receiveCoin** (string) - Required - Coin from receive
- **receiveNetwork** (string) - Required - Network from receive
- **typeSwap** (number) - Required - 1 - fixed, 2 -float
- **refundAddress** (string) - Optional - Refund address
- **memo** (string) - Optional - If needed memo
- **lastSource** (string) - Required - Deposit or receive

### Request Example
```json
{
  "depositCoin": "BTC",
  "depositAmount": 0.00047,
  "depositNetwork": "BTC",
  "receiveAddress": "49ALvhFRnJm4n1JsBG2fiAcrpPXeGEUvrLCvUjXNr9TqLk74pmj9X7s9aprrzRNNWHUgRrYbmysN7Xs8UJijXumPTjV5WVb",
  "receiveCoin": "XMR",
  "receiveNetwork": "XMR",
  "typeSwap": 2,
  "refundAddress": "",
  "memo": "",
  "lastSource": "deposit"
}
```

### Response
#### Success Response (200)
- **type** (object) - An object containing the type of swap (fixed or floating rate)
  - **typeSwap** (number) - A type of swap where 1 - Fixed, 2 - Float
- **pairs** (object) - An object containing information about coin pairs for deposit and withdrawal
  - **deposit** (object) - An object containing information about a coin for deposit and withdrawal
    - **coin** (object) - An object containing information out of a coin for deposit and withdrawal
      - **name** (string) - Coin name (eg BTC, XMR)
      - **value** (number) - The number of coins that will be sent or received
      - **network** (string) - The network in which the transaction takes place (eg ERC20, XMR)
      - **fullName** (string) - The full name of the coin
    - **address** (string) - Address to send or receive coins
    - **memo** (string) - Memo for transaction
  - **receive** (object) - An object containing information about a coin for deposit and withdrawal
    - **coin** (object) - An object containing information out of a coin for deposit and withdrawal
      - **name** (string) - Coin name (eg BTC, XMR)
      - **value** (number) - The number of coins that will be sent or received
      - **network** (string) - The network in which the transaction takes place (eg ERC20, XMR)
      - **fullName** (string) - The full name of the coin
    - **address** (string) - Address to send or receive coins
    - **memo** (string) - Memo for transaction
- **receiveTransaction** (object) - An object containing information about the received transaction
  - **txId** (string) - Receive transaction id
  - **address** (string) - Address to receive coins
  - **receivedTime** (string) - The time the transaction was received
  - **gettingInTheBlock** (string) - The time of receiving the first sending confirmation
  - **amount** (number | null) - null - Number of coins sending
  - **confirmation** (number | null) - null - Number of confirmations for the transaction for sending
  - **fees** (number | null) - null - Fees for sending funds
- **fees** (object) - An object containing information about commissions
  - **feeNodeDeposit** (number) - Fees for deposit
- **swapTime** (object) - An object containing the swap time
  - **end** (string) - Transaction completion time
  - **duration** (string) - Duration of the transaction
  - **start** (string) - Transaction start time
- **orderNumber** (string) - The unique identifier of the transaction
- **status** (number) - New - 9; Confirmation - 1; Exchanging - 3; Success - 4, 12; Overdue - 5; Error - 6; Pause - 10; Frozen - 11; Refund - 13
- **txId** (string) - Deposit transaction id
- **riskScore** (number | null) - null - Risk assessment for the transaction
- **receivedTime** (string) - Deposit receiving time
- **gettingInTheBlock** (string) - The time of receiving the first deposit confirmation
- **confirmation** (number | null) - null - Number of confirmations for the transaction for deposit

#### Response Example
```json
{
  "type": {
    "typeSwap": 2
  },
  "pairs": {
    "deposit": {
      "coin": {
        "name": "BTC",
        "value": 0.00047,
        "network": "BTC",
        "fullName": ""
      },
      "address": "bc1qt3uurp5yjl0s9hpc834nkxx37f99hn5xfqt8x3",
      "memo": ""
    },
    "receive": {
      "coin": {
        "name": "XMR",
        "value": 0.37555349507259705,
        "network": "XMR",
        "fullName": ""
      },
      "address": "49ALvhFRnJm4n1JsBG2fiAcrpPXeGEUvrLCvUjXNr9TqLk74pmj9X7s9aprrzRNNWHUgRrYbmysN7Xs8UJijXumPTjV5WVb",
      "memo": ""
    }
  },
  "receiveTransaction": {
    "txId": "",
    "address": "",
    "receivedTime": "",
    "gettingInTheBlock": "",
    "amount": null,
    "confirmation": null,
    "fees": null
  },
  "fees": {
    "feeNodeDeposit": 0.00009912
  },
  "swapTime": {
    "end": "",
    "duration": "",
    "start": "1728573590155"
  },
  "orderNumber": "RBGTSM",
  "status": 3,
  "txId": "a5398b56b451405bbd2804839100e29709e6f79f993b1ba2e466e952ab7940e4",
  "riskScore": null,
  "receivedTime": "1726833220",
  "gettingInTheBlock": "1728574893",
  "confirmation": 5
}
```
```

--------------------------------

### Authorization Process

Source: https://pegasusswap.com/api-docs/-authorization-process

Details on how to authorize API requests using an API key, signature, and payload.

```APIDOC
## Authorization Process

### Description
An authorization key is required for all requests to access API functions. This involves including specific parameters in the request headers.

### Method
All Methods (GET, POST, PUT, DELETE, etc.)

### Endpoint
All Endpoints

### Parameters
#### Headers
- **x-api-public-key** (string) - Required - Your public API key.
- **x-api-signature** (string) - Required - The signature generated using HMAC-SHA512.
- **x-api-payload** (string) - Required - The exact API name of the request being made.

### Signature Generation
`signature = hex(HMAC_SHA512(payload, key=api_secret))`

### Payload Meaning
| API Endpoint                  | Payload          |
|-------------------------------|------------------|
| /api/private/get-all-coins    | get-all-coins    |
| /api/private/get-coin-network | get-coin-network |
| /api/private/exchange-coin    | exchange-coin    |
| /api/private/get-transaction  | get-transaction  |
| /api/private/create-transaction| create-transaction|
```

--------------------------------

### Swap Pair Information API

Source: https://pegasusswap.com/api-docs/-exchange-pair-information

This API endpoint provides the amount the user will receive, the current swap rate, and other details about a specific swap pair based on the provided input.

```APIDOC
## GET /api/private/exchange-coin

### Description
This API endpoint provides the amount the user will receive, the current swap rate, and other details about a specific swap pair based on the provided input.

### Method
GET

### Endpoint
https://api.pegasusswap.com/api/private/exchange-coin

### Parameters
#### Query Parameters
- **amount** (string) - Required - Amount of currency you are going to send or get
- **coinFrom** (string) - Required - Currency to swap from
- **coinTo** (string) - Required - Currency to swap to
- **networkFrom** (string) - Optional - Network to swap from
- **networkTo** (string) - Optional - Network to swap to
- **lastSource** (string) - Required - We transfer the last input where the data is entered, to the deposit input or the receive input ( for example deposit or receive)
- **typeSwap** (string) - Required - 1 - fixed 2 -float

### Request Example
```json
{
  "example": "GET https://api.pegasusswap.com/api/private/exchange-coin?amount=10&coinFrom=eth&coinTo=usdt&lastSource=deposit&typeSwap=1"
}
```

### Response
#### Success Response (200)
- **pair** (string) - Swap pair
- **amount** (number) - Amount sent
- **exchangeRate** (number) - Swap rate
- **receive** (number) - Amount you will receive
- **minAmount** (number) - Min deposit
- **maxAmount** (number) - Max deposit

#### Response Example
```json
{
  "pair": "ETH_USDT",
  "amount": "10",
  "exchangeRate": 2462.1076313215262,
  "receive": 24008.541206617498,
  "minAmount": 0.03,
  "maxAmount": 2100
}
```
```

--------------------------------

### Retrieve Swap Information

Source: https://pegasusswap.com/api-docs/-retrieve-transaction-information

This API endpoint provides details about a specific swap using its unique ID.

```APIDOC
## GET /api/private/get-transaction

### Description
Retrieves detailed information about a specific swap transaction using its ID.

### Method
GET

### Endpoint
https://api.pegasusswap.com/api/private/get-transaction

### Parameters
#### Query Parameters
- **id** (string) - Required - The unique identifier for the swap transaction.

### Request Example
```
GET https://api.pegasusswap.com/api/private/get-transaction?id=RTGTLN
```

### Response
#### Success Response (200)
- **type** (object) - An object containing the type of swap (fixed or floating rate).
  - **typeSwap** (number) - A type of swap where 1 - Fixed, 2 - Float.
- **pairs** (object) - An object containing information about coin pairs for deposit and withdrawal.
  - **deposit/receive** (object) - An object containing information about a coin for deposit and withdrawal.
    - **coin** (object) - An object containing information out of a coin for deposit and withdrawal.
      - **name** (string) - Coin name (eg BTC, XMR).
      - **value** (number) - The number of coins that will be sent or received.
      - **network** (string) - The network in which the transaction takes place (eg ERC20, XMR).
      - **fullName** (string) - The full name of the coin.
    - **address** (string) - Address to send or receive coins.
    - **memo** (string) - Memo for transaction.
- **receiveTransaction** (object) - An object containing information about the received transaction.
  - **txId** (string) - Receive transaction id.
  - **address** (string) - Address to receive coins.
  - **receivedTime** (string) - The time the transaction was received.
  - **gettingInTheBlock** (string) - The time of receiving the first sending confirmation.
  - **amount** (number | null) - Number of coins sending.
  - **confirmation** (number | null) - Number of confirmations for the transaction for sending.
  - **fees** (number | null) - Fees for sending funds.
- **fees** (object) - An object containing information about commissions.
  - **feeNodeDeposit** (number) - Fees for deposit.
- **swapTime** (object) - An object containing the swap time.
  - **end** (string) - Transaction completion time.
  - **duration** (string) - Duration of the transaction.
  - **start** (string) - Transaction start time.
- **orderNumber** (string) - The unique identifier of the transaction.
- **status** (number) - Transaction status (New - 9; Confirmation - 1; Exchanging - 3; Success - 4, 12; Overdue - 5; Error - 6; Pause - 10; Frozen - 11; Refund - 13).
- **txId** (string) - Deposit transaction id.
- **riskScore** (number | null) - Risk assessment for the transaction.
- **receivedTime** (string) - Deposit receiving time.
- **gettingInTheBlock** (string) - The time of receiving the first deposit confirmation.
- **confirmation** (number | null) - Number of confirmations for the transaction for deposit.
- **createdAt** (string) - Transaction creation time.

#### Response Example
```json
{
  "type": {
    "typeSwap": 2
  },
  "pairs": {
    "deposit": {
      "coin": {
        "name": "BTC",
        "value": 0.00047,
        "network": "BTC",
        "fullName": ""
      },
      "address": "bc1qt3uurp5yjl0s9hpc834nkxx37f99hn5xfqt8x3",
      "memo": ""
    },
    "receive": {
      "coin": {
        "name": "XMR",
        "value": 0.37555349507259705,
        "network": "XMR",
        "fullName": ""
      },
      "address": "49ALvhFRnJm4n1JsBG2fiAcrpPXeGEUvrLCvUjXNr9TqLk74pmj9X7s9aprrzRNNWHUgRrYbmysN7Xs8UJijXumPTjV5WVb",
      "memo": ""
    }
  },
  "receiveTransaction": {
    "txId": "",
    "address": "",
    "receivedTime": "",
    "gettingInTheBlock": "",
    "amount": null,
    "confirmation": null,
    "fees": null
  },
  "fees": {
    "feeNodeDeposit": 0.00009912
  },
  "swapTime": {
    "end": "",
    "duration": "",
    "start": "1728573590155"
  },
  "orderNumber": "RBGTSM",
  "status": 3,
  "txId": "a5398b56b451405bbd2804839100e29709e6f79f993b1ba2e466e952ab7940e4",
  "riskScore": null,
  "receivedTime": "1726833220",
  "gettingInTheBlock": "1728574893",
  "confirmation": 5,
  "createdAt": "2025-02-11T13:08:25.367Z"
}
```
```

--------------------------------

### Retrieve Swap Pair Information (API)

Source: https://pegasusswap.com/api-docs/-exchange-pair-information

This API endpoint allows you to retrieve information about a specific swap pair. It requires parameters like the amount, source and destination currencies, and swap type. It returns details such as the current exchange rate, minimum and maximum deposit amounts, and the amount you will receive.

```HTTP
GET: https://api.pegasusswap.com/api/private/exchange-coin?amount=10&coinFrom=eth&coinTo=usdt&lastSource=deposit&typeSwap=1
```

--------------------------------

### API Base URL and Protocol

Source: https://pegasusswap.com/api-docs/index

Specifies the base URL for all API requests and mandates the use of the HTTPS protocol for secure communication.

```text
API URL:
https://api.pegasusswap.com

Protocol: HTTPS only.
```

--------------------------------

### PegasusSwap API Base Information

Source: https://pegasusswap.com/api-docs/-basic-info

Provides essential information about the PegasusSwap API, including the base URL, protocol, and required headers for all requests.

```APIDOC
## PegasusSwap API Base Information

### Description
This section outlines the fundamental details for interacting with the PegasusSwap API, including the base URL, the required communication protocol, and the standard headers that must be included in every request.

### API URL
`https://api.pegasusswap.com`

### Protocol
`HTTPS` only.

### Authentication
All endpoints require valid API credentials.

### Headers
All requests must be executed using HTTPS and include the following headers:

| Header        | Value            |
|---------------|------------------|
| `Accept`      | `application/json` |
| `Content-Type`| `application/json` |
```

--------------------------------

### API Authentication Headers

Source: https://pegasusswap.com/api-docs/index

Details the required headers for API authentication, including the public key, signature, and payload. The signature is generated using HMAC-SHA512.

```text
Headers  
---
Accept| application/json  
Content-Type| application/json  

x-api-public-key| {publicKey}  
x-api-signature| {signature}  
x-api-payload| {payload}  

signature = hex(HMAC_SHA512(payload, key=api_secret))
```

--------------------------------

### Retrieve Available Currencies List - API

Source: https://pegasusswap.com/api-docs/-available-currencies-list

This API endpoint provides a paginated list of all available currencies for deposit or withdrawal. It supports filtering by currency name, and specifying deposit/receive coins and networks. The response includes pagination details and a list of coins with their networks.

```http
GET: https://api.pegasusswap.com/api/private/get-all-coins?page=1&limit=5&method=1
```

--------------------------------

### Retrieve Swap Information

Source: https://pegasusswap.com/api-docs/-retrieve-transaction-information

Fetches detailed information about a specific swap transaction using its unique ID. This endpoint requires a 'swap ID' as a parameter and returns comprehensive details about the transaction's status, involved assets, and timing.

```HTTP
GET: https://api.pegasusswap.com/api/private/get-transaction?id=RTGTLN
```

--------------------------------

### Retrieve Currency Networks

Source: https://pegasusswap.com/api-docs/-retrieve-currency-networks

This API endpoint provides the networks associated with a specific currency code.

```APIDOC
## GET /api/private/get-coin-network

### Description
This API endpoint provides the networks associated with a specific currency code.

### Method
GET

### Endpoint
https://api.pegasusswap.com/api/private/get-coin-network

### Parameters
#### Query Parameters
- **coin** (string) - Required - Currency code (Coin sub name)

### Request Example
```
GET https://api.pegasusswap.com/api/private/get-coin-network?coin=eth
```

### Response
#### Success Response (200)
- **deposit** (array) - List with deposit networks
- **withdraws** (array) - List with withdraws networks
- **subName** (string) - Sub name network

#### Response Example
```json
{
  "deposit": [
    {
      "subName": "ERC20"
    }
  ],
  "withdraws": [
    {
      "subName": "ERC20"
    }
  ]
}
```
```

--------------------------------

### Payload Mapping for API Endpoints

Source: https://pegasusswap.com/api-docs/index

Provides a mapping between API endpoints and their corresponding payload values, which must be included in the request header for proper API function identification.

```text
API Endpoint| Payload  
---|---
/api/private/get-all-coins| get-all-coins  
/api/private/get-coin-network| get-coin-network  
/api/private/exchange-coin| exchange-coin  
/api/private/get-transaction| get-transaction  
/api/private/create-transaction| create-transaction
```

--------------------------------

### HMAC-SHA512 Signature Generation

Source: https://pegasusswap.com/api-docs/-authorization-process

The API signature is generated using the HMAC-SHA512 algorithm. It requires the payload and the API secret key to produce a hexadecimal hash.

```python
import hmac
import hashlib

def generate_signature(payload, api_secret):
    signature = hmac.new(api_secret.encode('utf-8'), payload.encode('utf-8'), hashlib.sha512).hexdigest()
    return signature
```

--------------------------------

### API Authorization Headers

Source: https://pegasusswap.com/api-docs/-authorization-process

All requests to the PegasusSwap API require an authorization key passed in the request headers. This includes a public key, a signature generated using HMAC-SHA512, and a payload specifying the API call.

```http
Headers:
---
x-api-public-key| {publicKey}
x-api-signature| {signature}
x-api-payload| {payload}
```

--------------------------------

### PegasusSwap API Error Handling

Source: https://pegasusswap.com/api-docs/-errors

This section details common error responses encountered when using the PegasusSwap API. Understanding these errors is crucial for robust integration and debugging.

```APIDOC
## API Error Responses

### Description
This section provides details on various error codes and messages returned by the PegasusSwap API. These errors help identify issues related to transaction amounts, invalid inputs, authentication, rate limiting, and server-side problems.

### Method
N/A (Error responses are general and apply across multiple endpoints)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Common Error Structures
- **statusCode** (integer) - The HTTP status code indicating the error type.
- **message** (string or array of strings) - A message describing the error.

#### Specific Error Examples:

##### Amount to swap is below the minimum
- **Description**: The amount specified for the swap is less than the minimum allowed.
- **Response Example**:
```json
{
  "statusCode": 400,
  "message": "Amount to swap is below the possible min amount to swap"
}
```

##### Amount to swap is above the maximum
- **Description**: The amount specified for the swap is greater than the maximum allowed.
- **Response Example**:
```json
{
  "statusCode": 400,
  "message": "Amount to swap is higher the possible max amount to swap"
}
```

##### Invalid withdrawal address
- **Description**: The provided withdrawal address is invalid or not supported by the system.
- **Response Example**:
```json
{
  "statusCode": 400,
  "message": "Invalid withdrawal address."
}
```

##### Errors about incorrectly passed keys
- **Description**: Issues related to missing, null, undefined, or non-string values for required keys like 'id'.
- **Response Example**:
```json
{
  "message": [
    "id should not be null or undefined",
    "id must be a string",
    "id should not be empty"
  ],
  "error": "Bad Request",
  "statusCode": 400
}
```

##### Invalid public key
- **Description**: An invalid or unrecognized `x-api-public-key` was provided in the request headers.
- **Response Example**:
```json
{
  "statusCode": 403,
  "message": "Invalid public key."
}
```

##### Invalid payload
- **Description**: An invalid or unrecognized `x-api-payload` was provided in the request headers.
- **Response Example**:
```json
{
  "statusCode": 403,
  "message": "Invalid payload."
}
```

##### Invalid signature
- **Description**: The `x-api-signature` header value does not match the expected signature. Ensure correct signature generation.
- **Response Example**:
```json
{
  "statusCode": 403,
  "message": "Invalid signature."
}
```

##### Not found
- **Description**: The requested resource could not be found. Verify the input data.
- **Response Example**:
```json
{
  "statusCode": 404,
  "message": "Not found."
}
```

##### Request limit exceeded
- **Description**: The `x-api-public-key` has exceeded its allowed request rate. Please try again later.
- **Response Example**:
```json
{
  "statusCode": 429,
  "message": "You have exceeded your request limit. Please try again later."
}
```

##### Error retrieving coins data
- **Description**: A server-side issue occurred while fetching coin data.
- **Response Example**:
```json
{
  "statusCode": 500,
  "message": "Error retrieving coins data."
}
```

##### Server error
- **Description**: A general server-side error occurred.
- **Response Example**:
```json
{
  "statusCode": 500,
  "message": "Server error."
}
```

##### Unexpected error
- **Description**: An unspecified server-side error. Contact support if the problem persists.
- **Response Example**:
```json
{
  "statusCode": 500,
  "message": "Unexpected error."
}
```

##### Failed to process the request
- **Description**: An internal error prevented the request from being processed.
- **Response Example**:
```json
{
  "statusCode": 500,
  "message": "Failed to process the request."
}
```

##### Failed to create transaction
- **Description**: The server encountered an internal error while attempting to create a new transaction.
- **Response Example**:
```json
{
  "statusCode": 500,
  "message": "Failed create transaction."
}
```

##### Transaction not found or access denied
- **Description**: The specified transaction ID does not exist or does not belong to the authenticated partner.
- **Response Example**:
```json
{
  "statusCode": 404,
  "message": "Transaction not found or access denied"
}
```

##### Failed to update refund address
- **Description**: An internal server error occurred while trying to update the refund address.
- **Response Example**:
```json
{
  "statusCode": 500,
  "message": "Failed to update refund address"
}
```
```

--------------------------------

### API Payload Mapping

Source: https://pegasusswap.com/api-docs/-authorization-process

The payload field in the request header must exactly match the API name of the request being made. This ensures the API correctly routes and processes the request.

```text
API Endpoint| Payload
---|---
/api/private/get-all-coins| get-all-coins
/api/private/get-coin-network| get-coin-network
/api/private/exchange-coin| exchange-coin
/api/private/get-transaction| get-transaction
/api/private/create-transaction| create-transaction
```

--------------------------------

### PegasusSwap API Error: Amount too low

Source: https://pegasusswap.com/api-docs/-errors

This error occurs when the amount provided for a swap is below the minimum allowed threshold. The response includes a status code and a descriptive message.

```JSON
{
  "statusCode": 400,
  "message": "Amount to swap is below the possible min amount to swap"
}
```

--------------------------------

### PegasusSwap API Error: Not found

Source: https://pegasusswap.com/api-docs/-errors

This error is returned when the requested resource or data cannot be located. It suggests verifying the input data for correctness. The response contains the status code and a 'Not found' message.

```JSON
{
  "statusCode": 404,
  "message": "Not found."
}
```

--------------------------------

### Update Refund Address

Source: https://pegasusswap.com/api-docs/-update-refund-address

Allows a partner to add or update the refund address for a specific, existing transaction that they own.

```APIDOC
## PATCH /api/private/update-refund-address

### Description
This API endpoint allows a partner to add or update the refund address for a specific, existing transaction that they own.

### Method
PATCH

### Endpoint
https://api.pegasusswap.com/api/private/update-refund-address

### Parameters
#### Request Body
- **id** (string) - Required - The unique identifier (orderNumber) of the transaction to update.
- **refundAddress** (string) - Required - The new refund address to be set for the specified transaction.

### Request Example
```json
{
  "id": "RBGTSM",
  "refundAddress": "ltc1q...your...refund...address...here"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating success.
- **orderNumber** (string) - The unique identifier of the updated transaction.
- **newRefundAddress** (string) - The refund address that was successfully set.

#### Response Example
```json
{
  "message": "Refund address updated successfully",
  "orderNumber": "RBGTSM",
  "newRefundAddress": "ltc1q...your...refund...address...here"
}
```
```

--------------------------------

### PegasusSwap API Error: Transaction not found or access denied

Source: https://pegasusswap.com/api-docs/-errors

Returned if a transaction with the specified ID does not exist or if the requesting partner does not have access to it. The response includes a 404 status code and a descriptive message.

```JSON
{
  "statusCode": 404,
  "message": "Transaction not found or access denied"
}
```

--------------------------------

### PegasusSwap API Error: Invalid public key

Source: https://pegasusswap.com/api-docs/-errors

Occurs when an unrecognized or invalid 'x-api-public-key' is supplied in the request headers. The response contains the relevant status code and error message.

```JSON
{
  "statusCode": 403,
  "message": "Invalid public key."
}
```

--------------------------------

### PegasusSwap API Error: Unexpected server error

Source: https://pegasusswap.com/api-docs/-errors

An unspecified error occurring on the server. If the issue persists, users are advised to contact support. The response includes a 500 status code and an 'Unexpected error' message.

```JSON
{
  "statusCode": 500,
  "message": "Unexpected error."
}
```

--------------------------------

### Update Refund Address - PATCH Request

Source: https://pegasusswap.com/api-docs/-update-refund-address

This endpoint allows partners to add or update the refund address for a specific, existing transaction. It requires the transaction ID and the new refund address in the request body. The response confirms the update and provides the order number and the new refund address.

```HTTP
PATCH: https://api.pegasusswap.com/api/private/update-refund-address
```

```JSON
{
  "id": "RBGTSM",
  "refundAddress": "ltc1q...your...refund...address...here"
}
```

```JSON
{
  "message": "Refund address updated successfully",
  "orderNumber": "RBGTSM",
  "newRefundAddress": "ltc1q...your...refund...address...here"
}
```

--------------------------------

### PegasusSwap API Error: Request limit exceeded

Source: https://pegasusswap.com/api-docs/-errors

Occurs when the API key has surpassed the allowed number of requests within a given timeframe. The response includes a status code and a message advising to try again later.

```JSON
{
  "statusCode": 429,
  "message": "You have exceeded your request limit. Please try again later."
}
```

--------------------------------

### PegasusSwap API Error: Invalid withdrawal address

Source: https://pegasusswap.com/api-docs/-errors

Indicates that the provided withdrawal address is either invalid or not supported by the system. The error response includes the status code and a message explaining the issue.

```JSON
{
  "statusCode": 400,
  "message": "Invalid withdrawal address."
}
```
Tokens:
Raw