OmniBridge

https://docs.en.omnibridge.pro
Admin
OmniBridge is a cross-chain protocol that provides API services for enabling swaps and transfers...
Tokens:24,636
Snippets:85
Trust Score:5.2
Update:9 months ago
Show doc for...
Tokens:
Raw
### Query Trade Data with Node.js

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/all-orders

This Node.js example demonstrates how to query all trade data using the axios library. It sends POST requests to the specified API endpoint with required parameters and logs the response. Ensure axios is installed (`npm install axios`).

```javascript
//getToken example 
import axios from 'axios'
const params = {
    equipmentNo:"zfgryh918f93a19fdg6918a68cf5",
    sourceType:"H5",
    userNo:"",
    sessionUuid:"",
    orderId:"",
    sourceFlag:"widget",
    pageNo:1,
    pageSize:5,
    fromAddress:"0x19b9918f...f85ad08ba0"
}
const res = await axios.post('https://{host}/api/v2/queryAllTrade', params )
console.log(res)
```

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

### Get Coin List API Request Examples

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/check-token-types-list-port

Examples of how to call the Get Coin List API using Java and Node.js. These snippets demonstrate making POST requests with JSON payloads to retrieve token information.

```java
OkHttpClient client = new OkHttpClient();
  
  MediaType mediaType = MediaType.parse("application/json");
  RequestBody body = RequestBody.create(mediaType, "{\"supportType\":\"advanced\"}");
  Request request = new Request.Builder()
    .url("https://{host}/api/v1/queryCoinList")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("cache-control", "no-cache")
    .build();
  
  Response response = client.newCall(request).execute();
```

```javascript
//getToken example 
   import axios from 'axios'
   const params = {
      supportType: 'advanced',
    }
   const res = await axios.post('https://{host}/api/v1/queryCoinList', params )
   console.log(res)
```

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

### Request Order List Example (JSON)

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/all-orders

An example of the JSON payload to send when requesting an order list. This includes mandatory fields like equipmentNo and sourceType, along with optional pagination parameters.

```json
{
    "equipmentNo":"SFjeigreEIFegjieFei",
    "sourceType":"H5",
    "pageNo":"1",
    "pageSize":"10"
}
```

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

### Coin Data Response Example (YAML)

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/check-token-types-list-port

This YAML snippet illustrates the structure of a typical successful API response containing a list of supported coins. It includes details like coin codes, image URLs, names, and information about supported networks. Note that the 'noSupportCoin' field may indicate tokens that are not supported or have name discrepancies.

```yaml
{
    "data": [
      {
          "coinAllCode": "Bitcoin",
          "coinCode": "BTC",
          "coinImageUrl": "/static/image/coins/bitcoin.png",
          "coinName": "比特币",
          "contact": "",
          "isSupportAdvanced": "Y",
          "mainNetwork": "",
          "noSupportCoin": "BCC,SAN,ICX,EET,ETDM,BCC,GZRO,DTO,UCTT"
      },
      {
          "coinAllCode": "Ether",
          "coinCode": "ETH",
          "coinImageUrl": "/static/image/coins/ether.png",
          "coinName": "以太币",
          "contact": "",
          "isSupportAdvanced": "Y",
          "mainNetwork": "",
          "noSupportCoin": "BCC,SAN,ICX,EET,ETDM,BCC,GZRO,DTO,UCTT"
      },
      {
          "coinAllCode": "EOS",
          "coinCode": "EOS",
          "coinImageUrl": "",
          "coinName": "基数链",
          "contact": "",
          "isSupportAdvanced": "Y",
          "mainNetwork": "",
          "noSupportCoin": "BCC,SAN,ICX,EET,ETDM,BCC,GZRO,DTO,UCTT"
      },
      {
          "coinAllCode": "Stellar",
          "coinCode": "XLM",
          "coinImageUrl": "",
          "coinName": "Stellar",
          "contact": "",
          "isSupportAdvanced": "Y",
          "mainNetwork": "",
          "noSupportCoin": "BCC,SAN,TCT,ICX,GAT,CK.USD,EET,ETDM,USDC,BCC,GZRO,DTO,LV,TRX,DAI,UCTT"
      },
      {
          "coinAllCode": "Litecoin",
          "coinCode": "LTC",
          "coinImageUrl": "/static/image/coins/litecoin.png",
          "coinName": "莱特币",
          "contact": "",
          "isSupportAdvanced": "Y",
          "mainNetwork": "",
          "noSupportCoin": "BCC,SAN,ICX,EET,ETDM,BCC,GZRO,DTO,UCTT"
      },
        ...
    ],
      "resCode": "800",
      "resMsg": "成功"
  }
```

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

### Fetch OmniBridge Base Info using Objective-C

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

This Objective-C example demonstrates how to make a POST request to the /api/v1/getBaseInfo endpoint. It configures headers, parameters, and handles the response or errors. Dependencies include Foundation.h.

```objectivec
#import <Foundation/Foundation.h>
  
  NSDictionary *headers = @{ @"Content-Type": @"application/json",
                             @"cache-control": @"no-cache" };
  NSDictionary *parameters = @{ @"depositCoinCode": @"BTC",
                                @"receiveCoinCode": @"ETH" };
  
  NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
  
  NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://{host}/api/v1/getBaseInfo"] 
                                                         cachePolicy:NSURLRequestUseProtocolCachePolicy 
                                                     timeoutInterval:10.0];
  [request setHTTPMethod:@"POST"];
  [request setAllHTTPHeaderFields:headers];
  [request setHTTPBody:postData];
  
  NSURLSession *session = [NSURLSession sharedSession];
  NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                              completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                                                  if (error) {
                                                      NSLog(@"%@", error);
                                                  } else {
                                                      NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
                                                      NSLog(@"%@", httpResponse);
                                                  }
                                              }];
  [dataTask resume];
  

```

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

### C# Request Example for Get Fee Rates

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

This C# code snippet shows how to call the OmniBridge API's /api/v1/getBaseInfo endpoint using RestClient. It configures a POST request with the appropriate headers and body, including the deposit and receive coin codes. This example requires the RestSharp library to be installed.

```csharp
var client = new RestClient("https://{host}/api/v1/getBaseInfo");
  var request = new RestRequest(Method.POST);
  request.AddHeader("cache-control", "no-cache");
  request.AddHeader("Content-Type", "application/json");
  request.AddParameter("undefined", "{\"depositCoinCode\":\"BTC\",\"receiveCoinCode\":\"ETH\"}", ParameterType.RequestBody);
  IRestResponse response = client.Execute(request);
```

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

### Java Request Example for Get Fee Rates

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

This Java code snippet demonstrates how to make a POST request to the OmniBridge API's /api/v1/getBaseInfo endpoint using OkHttpClient. It sets the content type to application/json and includes the necessary request body with token codes. Ensure you have the OkHttpClient library included in your project.

```java
OkHttpClient client = new OkHttpClient();
  
  MediaType mediaType = MediaType.parse("application/json");
  RequestBody body = RequestBody.create(mediaType, "{\"depositCoinCode\":\"BTC\",\"receiveCoinCode\":\"ETH\"}");
  Request request = new Request.Builder()
    .url("https://{host}/api/v1/getBaseInfo")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("cache-control", "no-cache")
    .build();
  
  Response response = client.newCall(request).execute();
```

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

### Sample Order List Response (JSON)

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/all-orders

A sample JSON response received after successfully querying the order list. It contains pagination details and a list of order objects, each with specific trade information.

```json
{
    "data": {
        "pageContent": [
            {
                "beginDate": "2022-03-10 18:44:21",
                "chainFee": "0.001",
                "changeType": "advanced",
                "depositFeeRate": "0.002",
                "detailState": "timeout",
                "feeCoinAmt": "0.004",
                "feeCoinCode": "ETH",
                "fromCoinAmt": "2",
                "fromCoinCode": "ETH",
                "instantRate": "6.923076923076",
                "isNft": "",
                "nftUrl": "",
                "orderId": "f94e631b-d99b-4dd5-98f7-09bf99d16d94",
                "payTokenUrl": "",
                "percentChange": "",
                "router": {},
                "toCoinAmt": "13.713109",
                "toCoinCode": "BNB(BSC)",
                "tradeFlag": "",
                "tradeState": "timeout"
            },
            {
                "beginDate": "2022-03-10 18:30:36",
                "chainFee": "0.001",
                "changeType": "advanced",
                "depositFeeRate": "0.002",
                "detailState": "timeout",
                "feeCoinAmt": "0.002",
                "feeCoinCode": "ETH",
                "fromCoinAmt": "1",
                "fromCoinCode": "ETH",
                "instantRate": "6.923076923076",
                "isNft": "",
                "nftUrl": "",
                "orderId": "864ca993-8fb8-4715-aab6-cd2e87b625cb",
                "payTokenUrl": "",
                "percentChange": "",
                "router": {},
                "toCoinAmt": "6.865979",
                "toCoinCode": "BNB(BSC)",
                "tradeFlag": "",
                "tradeState": "timeout"
            }
        ],
        "pageNo": 1,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1
    },
    "resCode": "800",
    "resMsg": "成功",
    "resMsgEn": ""
}
```

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

### GET /api/v2/queryAllTrade

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/all-orders

Fetches a paginated list of trade orders. Requires equipment number and source type for filtering.

```APIDOC
## GET /api/v2/queryAllTrade

### Description
Retrieves a list of trade orders. This endpoint supports filtering by `equipmentNo` and `sourceType`, and allows for pagination using `pageNo` and `pageSize`.

### Method
GET

### Endpoint
`https://{host}/api/v2/queryAllTrade`

### Parameters
#### Query Parameters
- **equipmentNo** (string) - Required - The unique identifier for the equipment.
- **sourceType** (string) - Required - The type of source (e.g., ANDROID, IOS, H5).
- **pageNo** (string) - Optional - The page number for pagination. Defaults to '1'.
- **pageSize** (string) - Optional - The number of records to display per page. Defaults to '10'.

### Request Example
```json
{
    "equipmentNo": "SFjeigreEIFegjieFei",
    "sourceType": "H5",
    "pageNo": "1",
    "pageSize": "10"
}
```

### Response
#### Success Response (200)
- **pageContent** (array) - An array of trade order objects.
  - **beginDate** (string) - The start date of the trade.
  - **chainFee** (string) - The chain fee for the trade.
  - **changeType** (string) - The type of change for the trade.
  - **depositFeeRate** (string) - The deposit fee rate.
  - **detailState** (string) - The detailed state of the trade.
  - **feeCoinAmt** (string) - The amount of fee coin.
  - **feeCoinCode** (string) - The currency code for the fee.
  - **fromCoinAmt** (string) - The amount of the source currency.
  - **fromCoinCode** (string) - The currency code of the source.
  - **instantRate** (string) - The instant exchange rate.
  - **isNft** (string) - Indicates if the trade involves an NFT.
  - **nftUrl** (string) - The URL of the NFT.
  - **orderId** (string) - The unique identifier for the order.
  - **payTokenUrl** (string) - The URL for the payment token.
  - **percentChange** (string) - The percentage change.
  - **router** (object) - Routing information.
  - **toCoinAmt** (string) - The amount of the destination currency.
  - **toCoinCode** (string) - The currency code of the destination.
  - **tradeFlag** (string) - Flag for the trade.
  - **tradeState** (string) - The state of the trade (e.g., 'timeout', 'complete').
- **pageNo** (string) - The current page number.
- **pageSize** (string) - The number of records per page.
- **totalCount** (string) - The total number of records available.
- **totalPage** (string) - The total number of pages.
- **resCode** (string) - Response code indicating success or failure.
- **resMsg** (string) - Success or error message in Chinese.
- **resMsgEn** (string) - Success or error message in English.

#### Response Example
```json
{
    "data": {
        "pageContent": [
            {
                "beginDate": "2022-03-10 18:44:21",
                "chainFee": "0.001",
                "changeType": "advanced",
                "depositFeeRate": "0.002",
                "detailState": "timeout",
                "feeCoinAmt": "0.004",
                "feeCoinCode": "ETH",
                "fromCoinAmt": "2",
                "fromCoinCode": "ETH",
                "instantRate": "6.923076923076",
                "isNft": "",
                "nftUrl": "",
                "orderId": "f94e631b-d99b-4dd5-98f7-09bf99d16d94",
                "payTokenUrl": "",
                "percentChange": "",
                "router": {},
                "toCoinAmt": "13.713109",
                "toCoinCode": "BNB(BSC)",
                "tradeFlag": "",
                "tradeState": "timeout"
            }
        ],
        "pageNo": 1,
        "pageSize": 10,
        "totalCount": 2,
        "totalPage": 1
    },
    "resCode": "800",
    "resMsg": "成功",
    "resMsgEn": ""
}
```
```

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

### Response Example - Upload Transaction Hash

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/upload-transaction-hash

Example JSON payload for the Upload Transaction Hash API response. Indicates the success or failure of the transaction hash update.

```json
{
    "resCode": "800",
    "resMsg": "成功",
    "data": "SUCCESS"
}
```

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

### Fetch OmniBridge Base Info using Node.js

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

This Node.js example uses the 'axios' library to send a POST request to the OmniBridge API's /api/v1/getBaseInfo endpoint. It defines parameters for deposit and receive coin codes and logs the response. Ensure 'axios' is installed.

```javascript
  //getToken example 
  import axios from 'axios'
  const params = {
     depositCoinCode: 'ETH', 
     receiveCoinCode: 'BNB(BSC)', 
  }
  const res = await axios.post('https://{host}/api/v1/getBaseInfo', params )
  console.log(res)

```

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

### Request Example - Upload Transaction Hash

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/upload-transaction-hash

Example JSON payload for the Upload Transaction Hash API request. It requires the orderId and depositTxid for updating transaction records.

```json
{
    "orderId": "33120af8-1866-4cb6-99a8-2c303f490c2c",
    "depositTxid": "0x123"
}
```

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

### OmniBridge Pro API: Account Exchange Response Example

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/create-order

This snippet illustrates a typical response from the /api/v2/accountExchange endpoint. It includes detailed information about the transaction, such as fees, timestamps, coin amounts and codes, transaction IDs, and the state of the deposit and order.

```json
{
    "data": {
        "chainFee": "0.001",
        "createTime": "2022-03-10 18:44:21",
        "dealFinishTime": null,
        "depositCoinAmt": "2",
        "depositCoinCode": "ETH",
        "depositCoinFeeAmt": "0.004",
        "depositCoinFeeRate": "0.002",
        "depositCoinState": "wait_send",
        "depositFeeRate": "0.002",
        "depositTxid": "",
        "destinationAddr": "0xAE93FA34f728855cE663cf9FcF8e32148F079071",
        "detailState": "wait_deposit_send",
        "instantRate": "6.856554564172",
        "kycUrl": "",
        "orderId": "f94e631b-d99b-4dd5-98f7-09bf99d16d94",
        "orderState": "wait_deposits",
        "platformAddr": "0x3181af4f7cc7251a6a4eda75526c8abe10106db8",
        "receiveCoinAmt": "13.713109",
        "receiveCoinCode": "BNB(BSC)",
        "receiveSwftAmt": "2416.89",
        "refundAddr": "0xAE93FA34f728855cE663cf9FcF8e32148F079071",
        "refundCoinAmt": "",
        "refundDepositTxid": ""
    }
}
```

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

### POST /api/v1/queryCoinList

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/check-token-types-list-port

Retrieves a list of coin types that can be traded or displayed to users. It allows filtering based on support type and main network.

```APIDOC
## POST /api/v1/queryCoinList

### Description
Retrieves a list of coin types. This endpoint can be used to display to users which tokens are available for trading and their associated details.

### Method
POST

### Endpoint
`https://{host}/api/v1/queryCoinList`

### Parameters
#### Query Parameters
- **supportType** (string) - Optional - Advanced: returns only currencies that support cross-chain exchange. If omitted, returns all currencies.
- **mainNetwork** (string) - Optional - Filters coins by their main network (e.g., "ETH", "BTC").
- **sourceFlag** (string) - Required - Identifier for the source of the request.

#### Request Body
*Note: While the documentation shows an example request body, the parameters are typically passed as query parameters for this endpoint.*

### Request Example
```json
{
    "supportType":"advanced",
    "mainNetwork":"ETH",
    "sourceFlag": "xxx"
}
```

### Response
#### Success Response (200)
- **data** (array) - List of coin objects.
  - **coinAllCode** (string) - The full code name of the coin.
  - **coinCode** (string) - The short code of the coin.
  - **coinDecimal** (integer) - The number of decimal places for the coin.
  - **contact** (string) - The contract address if the coin is a token on a primary chain.
  - **isSupportAdvanced** (string) - 'Y' if advanced support is available, 'N' otherwise.
  - **isSupportMemo** (string) - 'Y' if memo support is available, 'N' otherwise.
  - **mainNetwork** (string) - The main network the coin belongs to.
  - **noSupportCoin** (string) - A comma-separated list of coins not supported by this configuration.
- **resCode** (string) - Response code (e.g., "800" for success).
- **resMsg** (string) - Response message in the local language.
- **resMsgEn** (string) - Response message in English.

#### Response Example
```json
{
    "data": [
        {
            "coinAllCode": "SwftCoin",
            "coinCode": "SWFTC",
            "coinDecimal": 8,
            "contact": "0x0bb217E40F8a5Cb79Adf04E1aAb60E5abd0dfC1e",
            "isSupportAdvanced": "Y",
            "isSupportMemo": "N",
            "mainNetwork": "ETH",
            "noSupportCoin": "BOS,YOYO,..."
        },
        {
            "coinAllCode": "TetherUS",
            "coinCode": "USDT",
            "coinDecimal": 6,
            "contact": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "isSupportAdvanced": "Y",
            "isSupportMemo": "N",
            "mainNetwork": "BTC",
            "noSupportCoin": "BCC,UCTT,..."
        }
    ],
    "resCode": "800",
    "resMsg": "success",
    "resMsgEn": ""
}
```
```

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

### Check Order Status API Request Example

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/check-order-status

This snippet demonstrates how to construct a request to the Check Order Status API. It requires the equipment number, source type, and order ID as parameters. The response provides detailed information about the order's current state and transaction history.

```json
{
    "equipmentNo":"SFjeigreEIFegjieFei",
    "sourceType":"H5",
    "orderId":"9d4a577d-fdb1-466c-8da2-a5ad3553260b"
}
```

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

### POST /websites/en_omnibridge_pro/cross-chain-swap-api/create-order

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api

Creates a new cross-chain swap order.

```APIDOC
## POST /websites/en_omnibridge_pro/cross-chain-swap-api/create-order

### Description
Creates a new cross-chain swap order.

### Method
POST

### Endpoint
https://api.omnibridge.pro/websites/en_omnibridge_pro/cross-chain-swap-api/create-order

### Parameters
#### Request Body
- **from_chain_id** (string) - Required - The ID of the source blockchain network.
- **to_chain_id** (string) - Required - The ID of the destination blockchain network.
- **from_token_address** (string) - Required - The contract address of the token on the source chain.
- **to_token_address** (string) - Required - The contract address of the token on the destination chain.
- **from_amount** (string) - Required - The amount of tokens to swap.
- **to_address** (string) - Required - The recipient's address on the destination chain.
- **slippage** (string) - Optional - The maximum acceptable price slippage.

### Request Example
```json
{
  "from_chain_id": "1",
  "to_chain_id": "137",
  "from_token_address": "0xA0b86991c6218b36c1d13418A40232653536BBe6",
  "to_token_address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
  "from_amount": "1000000000000000000",
  "to_address": "0x12345abcdeF67890",
  "slippage": "1"
}
```

### Response
#### Success Response (200)
- **order_id** (string) - The unique identifier for the created order.
- **estimated_receive_amount** (string) - The estimated amount of tokens to be received.
- **bridge_address** (string) - The address of the bridge contract.
- **bridge_chain_id** (string) - The chain ID of the bridge.
- **deadline** (string) - The deadline for the transaction.

#### Response Example
```json
{
  "order_id": "ORD123456789",
  "estimated_receive_amount": "999000000000000000",
  "bridge_address": "0xabcdef1234567890",
  "bridge_chain_id": "1",
  "deadline": "1678886400"
}
```
```

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

### POST /websites/en_omnibridge_pro/cross-chain-swap-api/check-token-types-list-port

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api

Retrieves a list of supported token types for cross-chain swaps.

```APIDOC
## POST /websites/en_omnibridge_pro/cross-chain-swap-api/check-token-types-list-port

### Description
Retrieves a list of supported token types for cross-chain swaps.

### Method
POST

### Endpoint
https://api.omnibridge.pro/websites/en_omnibridge_pro/cross-chain-swap-api/check-token-types-list-port

### Parameters
#### Query Parameters
- **chain_id** (string) - Required - The ID of the blockchain network.

### Request Body
None

### Response
#### Success Response (200)
- **data** (array) - List of supported token types.
  - **token_name** (string) - The name of the token.
  - **token_address** (string) - The contract address of the token.
  - **chain_id** (string) - The ID of the blockchain network.
  - **decimals** (integer) - The number of decimal places for the token.
  - **is_native** (boolean) - Indicates if the token is native to the chain.

#### Response Example
```json
{
  "data": [
    {
      "token_name": "USDC",
      "token_address": "0xA0b86991c6218b36c1d13418A40232653536BBe6",
      "chain_id": "1",
      "decimals": 6,
      "is_native": false
    }
  ]
}
```
```

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

### POST /websites/en_omnibridge_pro/cross-chain-swap-api/upload-gas-free-orders

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api

Uploads gas-free orders for cross-chain swaps.

```APIDOC
## POST /websites/en_omnibridge_pro/cross-chain-swap-api/upload-gas-free-orders

### Description
Uploads gas-free orders for cross-chain swaps.

### Method
POST

### Endpoint
https://api.omnibridge.pro/websites/en_omnibridge_pro/cross-chain-swap-api/upload-gas-free-orders

### Parameters
#### Request Body
- **orders** (array) - Required - A list of gas-free order objects.
  - **from_chain_id** (string) - Required - The ID of the source blockchain network.
  - **to_chain_id** (string) - Required - The ID of the destination blockchain network.
  - **from_token_address** (string) - Required - The contract address of the token on the source chain.
  - **to_token_address** (string) - Required - The contract address of the token on the destination chain.
  - **from_amount** (string) - Required - The amount of tokens to swap.
  - **to_address** (string) - Required - The recipient's address on the destination chain.

### Request Example
```json
{
  "orders": [
    {
      "from_chain_id": "1",
      "to_chain_id": "137",
      "from_token_address": "0xA0b86991c6218b36c1d13418A40232653536BBe6",
      "to_token_address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
      "from_amount": "1000000000000000000",
      "to_address": "0x12345abcdeF67890"
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that the gas-free orders were uploaded successfully.

#### Response Example
```json
{
  "message": "Gas-free orders uploaded successfully."
}
```
```

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

### POST /websites/en_omnibridge_pro/cross-chain-swap-api/all-orders

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api

Retrieves a list of all cross-chain swap orders.

```APIDOC
## POST /websites/en_omnibridge_pro/cross-chain-swap-api/all-orders

### Description
Retrieves a list of all cross-chain swap orders.

### Method
POST

### Endpoint
https://api.omnibridge.pro/websites/en_omnibridge_pro/cross-chain-swap-api/all-orders

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of orders to return.
- **offset** (integer) - Optional - The number of orders to skip.

### Request Body
None

### Response
#### Success Response (200)
- **orders** (array) - A list of swap orders.
  - **order_id** (string) - The unique identifier for the order.
  - **status** (string) - The current status of the order.
  - **created_at** (string) - The timestamp when the order was created.

#### Response Example
```json
{
  "orders": [
    {
      "order_id": "ORD123456789",
      "status": "COMPLETED",
      "created_at": "2023-03-15T10:00:00Z"
    },
    {
      "order_id": "ORD987654321",
      "status": "PENDING",
      "created_at": "2023-03-15T09:30:00Z"
    }
  ]
}
```
```

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

### GET /api/v1/getBaseInfo

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

Retrieves the fee rate between two specified tokens. It requires details about the deposit and receive coins, along with the amount and source flag.

```APIDOC
## GET /api/v1/getBaseInfo

### Description
Retrieves the fee rate between two specified tokens. It requires details about the deposit and receive coins, along with the amount and source flag.

### Method
GET

### Endpoint
https://{host}/api/v1/getBaseInfo

### Parameters
#### Query Parameters
- **depositCoinCode** (string) - Required - The code of the coin being deposited.
- **receiveCoinCode** (string) - Required - The code of the coin being received.
- **depositCoinAmt** (string) - Required - The amount of the deposited coin.
- **sourceFlag** (string) - Required - An identifier for the source of the request.

### Request Example
```json
{
    "depositCoinCode":"ETH",
    "receiveCoinCode":"BNB(BSC)",
    "depositCoinAmt":"1.5",
    "sourceFlag": "xxx"
}
```

### Response
#### Success Response (200)
- **chainFee** (string) - Fee charged for the blockchain transaction.
- **depositCoinFeeRate** (string) - Fee rate for the deposited coin.
- **depositMax** (string) - Maximum deposit amount.
- **depositMin** (string) - Minimum deposit amount.
- **instantRate** (string) - The exchange rate of the received currency to the deposited currency, accurate to ten decimal places.
- **burnRate** (string) - Burn rate, defaults to 0.
- **isSupportNoGas** (boolean) - Indicates if gas-free redemption is supported.
- **isSupport** (boolean) - Indicates if the exchange is supported.

#### Response Example
```json
{
    "data": {
        "chainFee": "0.001",
        "depositCoinFeeRate": "0.002",
        "depositMax": "14",
        "depositMin": "0.038603",
        "instantRate": "6.875775974236",
        "burnRate": "0",
        "isSupportNoGas": true,
        "isSupport": true
    },
    "resCode": "800",
    "resMsg": "success",
    "resMsgEn": ""
}
```
```

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

### Query Order State using Java

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/check-order-status

This Java code snippet demonstrates how to query the order state using the OkHttpClient. It sends a POST request to the /api/v2/queryOrderState endpoint with order and equipment details. Ensure the OkHttpClient library is included in your project dependencies.

```java
OkHttpClient client = new OkHttpClient();
  
  MediaType mediaType = MediaType.parse("application/json");
  RequestBody body = RequestBody.create(mediaType, "{\n    \"equipmentNo\": \"Zasdf352943090468518\",\n   \n    \"sourceType\": \"ANDROID\",\n\n    \"orderId\": \"de752da3-0ff7-4682-8038-d8e1f20cad95\"\n}");
  Request request = new Request.Builder()
    .url("https://{host}/api/v2/queryOrderState")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("cache-control", "no-cache")
    .build();
  
  Response response = client.newCall(request).execute();
```

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

### POST /websites/en_omnibridge_pro/cross-chain-swap-api/upload-multiple-transaction-hash

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api

Uploads multiple transaction hashes for cross-chain swaps.

```APIDOC
## POST /websites/en_omnibridge_pro/cross-chain-swap-api/upload-multiple-transaction-hash

### Description
Uploads multiple transaction hashes for cross-chain swaps.

### Method
POST

### Endpoint
https://api.omnibridge.pro/websites/en_omnibridge_pro/cross-chain-swap-api/upload-multiple-transaction-hash

### Parameters
#### Request Body
- **transactions** (array) - Required - A list of transaction objects.
  - **order_id** (string) - Required - The ID of the swap order.
  - **transaction_hash** (string) - Required - The hash of the transaction on the source chain.
  - **chain_id** (string) - Required - The ID of the blockchain network where the transaction occurred.

### Request Example
```json
{
  "transactions": [
    {
      "order_id": "ORD123456789",
      "transaction_hash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
      "chain_id": "1"
    },
    {
      "order_id": "ORD987654321",
      "transaction_hash": "0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987",
      "chain_id": "137"
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that the transaction hashes were uploaded successfully.

#### Response Example
```json
{
  "message": "Transaction hashes uploaded successfully."
}
```
```

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

### Get Base Information

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

This endpoint retrieves essential information for cryptocurrency exchanges, including deposit and receive limits, instant rates, and fee details. It requires the codes for the deposit and receive cryptocurrencies.

```APIDOC
## POST /api/v1/getBaseInfo

### Description
Retrieves base information for cryptocurrency exchanges, including deposit/receive limits, instant rates, and fee details.

### Method
POST

### Endpoint
https://{host}/api/v1/getBaseInfo

### Parameters
#### Request Body
- **depositCoinCode** (string) - Required - The code of the cryptocurrency to deposit.
- **receiveCoinCode** (string) - Required - The code of the cryptocurrency to receive.

### Request Example
```json
{
  "depositCoinCode": "BTC",
  "receiveCoinCode": "ETH"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains exchange-related data.
  - **depositMax** (string) - Maximum deposit amount.
  - **depositMin** (string) - Minimum deposit amount.
  - **instantRate** (string) - The current instant exchange rate.
  - **minerFee** (string) - The miner fee for the transaction. This is used for SWFTC fee calculations: `exchange fee = deposited amount * minerFee`.
  - **receiveCoinFee** (string) - The network fee deducted after a successful transfer, in the units of the received token. Used to calculate the approximate amount received or display network fees.
  - **burnRate** (string) - The burn rate.
  - **isSupportNoGas** (boolean) - Indicates if gas-free redemption is supported.
- **resCode** (string) - Response code.
- **resMsg** (string) - Response message.

#### Response Example
```json
{
    "data": {
        "depositMax": "1692690",
        "depositMin": "169269",
        "instantRate": "0.000000538438",
        "minerFee": "0.00004368",
        "receiveCoinFee": "0.009328",
        "burnRate": "0",
        "isSupportNoGas": true
    },
    "resCode": "800",
    "resMsg": "成功"
}
```

### Important Notes
- For advanced trading where the user's fee method is deposited tokens (not SWFTC), the `minerFee` parameter can be ignored. The transaction fee is a fixed 0.3%.
- Example: If depositing 0.1 BTC, the actual amount deducted for the transaction fee is 0.0003 BTC, and only 0.0997 BTC will be transferred for exchange.
```

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

### Check Order Status API Response Example

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/check-order-status

This snippet shows an example of the response received from the Check Order Status API. It includes data such as transaction fees, timestamps, coin amounts, and various states related to the order processing, such as deposit status and transaction status.

```json
{
    "data": {
        "chainFee": "0.001",
        "changeType": "advanced",
        "choiseFeeType": "3",
        "completeTime": null,
        "createTime": "2022-03-10 18:44:21",
        "dealFinishTime": null,
        "dealReceiveCoinAmt": "",
        "depositCoinAmt": "2",
        "depositCoinCode": "ETH",
        "depositCoinFeeAmt": "0.004",
        "depositCoinFeeRate": "0.002",
        "depositCoinState": "wait_send",
        "depositHashExplore": "https://etherscan.io/tx/null",
        "depositTxid": "",
        "destinationAddr": "0xAE93FA34f728855cE663cf9FcF8e32148F079071",
        "detailState": "wait_deposit_send",
        "instantRate": "6.874588522739",
        "isDiscount": "N",
        "isNft": "",
        "kycUrl": "",
        "nftUrl": "",
        "orderId": "f94e631b-d99b-4dd5-98f7-09bf99d16d94",
        "orderState": "wait_deposits",
        "payTokenUrl": "",
        "platformAddr": "0x3181af4f7cc7251a6a4eda75526c8abe10106db8",
        "receiveCoinAmt": "13.713109",
        "receiveCoinCode": "BNB(BSC)",
        "receiveHashExplore": "https://bscscan.com/tx/",
        "receiveSwftAmt": "2416.89",
        "refundAddr": "0xAE93FA34f728855cE663cf9FcF8e32148F079071",
        "refundCoinAmt": "",
        "refundCoinMinerFee": "",
        "refundDepositTxid": "",
        "refundHashExplore": "https://etherscan.io/tx/",
        "refundSwftAmt": "",
        "router": {},
        "swftCoinFeeRate": "0.001",
        "swftCoinState": "",
        "swftReceiveAddr": "",
        "swftRefundAddr": "",
        "timeoutShowPlatformAddr": "N",
        "tradeState": "",
        "transactionId": "",
        "burnRate": "0",
        "refundReason": ""
    },
    "resCode": "800",
    "resMsg": "success",
    "resMsgEn": ""
}
```

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

### POST /websites/en_omnibridge_pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api

Obtains the basic information and exchange rate for a cross-chain swap.

```APIDOC
## POST /websites/en_omnibridge_pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

### Description
Obtains the basic information and exchange rate for a cross-chain swap.

### Method
POST

### Endpoint
https://api.omnibridge.pro/websites/en_omnibridge_pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

### Parameters
#### Request Body
- **from_chain_id** (string) - Required - The ID of the source blockchain network.
- **to_chain_id** (string) - Required - The ID of the destination blockchain network.
- **from_token_address** (string) - Required - The contract address of the token on the source chain.
- **to_token_address** (string) - Required - The contract address of the token on the destination chain.
- **from_amount** (string) - Required - The amount of tokens to swap.

### Request Example
```json
{
  "from_chain_id": "1",
  "to_chain_id": "137",
  "from_token_address": "0xA0b86991c6218b36c1d13418A40232653536BBe6",
  "to_token_address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
  "from_amount": "1000000000000000000"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains exchange rate information.
  - **fee** (string) - The estimated fee for the swap.
  - **receive_amount** (string) - The estimated amount of tokens to receive on the destination chain.
  - **price** (string) - The exchange rate.
  - **min_receive_amount** (string) - The minimum amount of tokens to receive.
  - **max_receive_amount** (string) - The maximum amount of tokens to receive.

#### Response Example
```json
{
  "data": {
    "fee": "10000000000000000",
    "receive_amount": "999000000000000000",
    "price": "0.999",
    "min_receive_amount": "998000000000000000",
    "max_receive_amount": "1000000000000000000"
  }
}
```
```

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

### POST /websites/en_omnibridge_pro/cross-chain-swap-api/upload-transaction-hash

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api

Uploads a transaction hash for a cross-chain swap.

```APIDOC
## POST /websites/en_omnibridge_pro/cross-chain-swap-api/upload-transaction-hash

### Description
Uploads a transaction hash for a cross-chain swap.

### Method
POST

### Endpoint
https://api.omnibridge.pro/websites/en_omnibridge_pro/cross-chain-swap-api/upload-transaction-hash

### Parameters
#### Request Body
- **order_id** (string) - Required - The ID of the swap order.
- **transaction_hash** (string) - Required - The hash of the transaction on the source chain.
- **chain_id** (string) - Required - The ID of the blockchain network where the transaction occurred.

### Request Example
```json
{
  "order_id": "ORD123456789",
  "transaction_hash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
  "chain_id": "1"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that the transaction hash was uploaded successfully.

#### Response Example
```json
{
  "message": "Transaction hash uploaded successfully."
}
```
```

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

### Get Fee Rates Between Tokens

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/obtain-exchange-rate-basic-information-port

This endpoint retrieves the exchange rate and fee information for trading between two specified cryptocurrency tokens. It requires the codes for the deposit and receiving tokens, along with the deposit amount and a source flag. The response includes instant exchange rates, minimum and maximum deposit amounts, fee rates, and support status for gas-free transactions.

```HTTP
GET https://{host}/api/v1/getBaseInfo?depositCoinCode=ETH&receiveCoinCode=BNB(BSC)&depositCoinAmt=1.5&sourceFlag=xxx
```

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

### Batch Modify Transaction Hash Request Example (JSON)

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/upload-multiple-transaction-hash

This JSON object demonstrates the structure for submitting multiple transaction updates to the batchModifyTxId API. It includes a list of objects, each containing an order ID and its corresponding deposit transaction hash.

```json
{
  "modifyTxIdList": [
    {
      "orderId": "33434232-1556-yt6g-99a8-2c303f490c2c",
      "depositTxid": "0x643ccccccccccccccc4c4"
    },
    {
      "orderId": "33120af8-1866-4cb6-99a8-2c303f490c2c",
      "depositTxid": "0x123aaaaaaaaaaaaaaaaa6"
    }
  ]
}
```

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

### OmniBridge Pro API Details

Source: https://docs.en.omnibridge.pro/cross-chain-swap-api/check-order-status-1

This section details the parameters and their descriptions for the OmniBridge Pro API.

```APIDOC
## OmniBridge Pro API Parameters

### Description
This section outlines the parameters available within the OmniBridge Pro API, providing details on their types, requirements, and descriptions.

### Parameters

#### Response Fields

- **chainFee** (String) - gas fee after the exchange is completed.
- **changeType** (String) - Exchange type.
- **kycUrl** (String) - Kyc path that exceeds the quota of the day.
- **refundReason** (String) - Reasons for refund of coins. This can include reasons such as: illiquidity, amount error, kyc excess, address blacklist, goal chain maintenance, redemption amount not within range, deposit timeout, or interaction with risky addresses.
```
Tokens:
Raw