GinArea API

https://ginarea.org/api/doc
Admin
GinArea API is a comprehensive cryptocurrency trading platform API that enables users to manage...
Tokens:34,365
Snippets:168
Trust Score:5.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Bot start

Source: https://ginarea.org/api/doc

Starts a specific bot.

```APIDOC
## PUT /bots/{bot_id}/start

### Description
Starts a specific bot.

### Method
PUT

### Endpoint
https://ginarea.org/api/bots/{bot_id}/start

### Parameters
#### Path Parameters
- **bot_id** (number <int64>) - Required - The ID of the bot to start.

#### Request Body
- The request body should be an empty JSON object or string.

### Request Example
```json
""
```

### Responses
#### Success Response (200)
Successful response

#### Error Response (401)
Authorization error

#### Error Response (500)
Internal Server Error
```

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

### Create Bot Request Example

Source: https://ginarea.org/api/doc

Example of a request payload for creating a new bot.

```APIDOC
## Create Bot

### Description
Creates a new bot with specified parameters.

### Request Body
- **strategyId** (integer) - Required - The ID of the strategy to use.
- **exchangeId** (integer) - Required - The ID of the exchange.
- **exchangeAccountId** (integer) - Required - The ID of the exchange account.
- **exchangeMarketIds** (integer) - Required - The ID of the exchange market.
- **name** (string) - Required - The name of the bot.
- **desc** (string) - Optional - A description for the bot.
- **source** (any) - Optional - Source information.
- **params** (object) - Required - Bot specific parameters.
  - **border** (object) - Optional
    - **bottom** (integer) - Optional
    - **top** (integer) - Optional
  - **dsblin** (boolean) - Optional
  - **dsblinbtr** (boolean) - Optional
  - **obap** (boolean) - Optional
  - **gap** (object) - Optional
    - **isg** (number) - Optional
    - **maxS** (integer) - Optional
    - **minS** (number) - Optional
    - **tog** (number) - Optional
  - **gs** (number) - Optional
  - **gsr** (number) - Optional
  - **maxOp** (integer) - Optional
  - **q** (object) - Optional
    - **maxQ** (integer) - Optional
    - **minQ** (integer) - Optional
    - **qr** (integer) - Optional
  - **ris** (boolean) - Optional
  - **side** (integer) - Optional
  - **tr** (object) - Optional
    - **mdTr** (integer) - Optional
    - **minToTr** (integer) - Optional
    - **tr** (integer) - Optional
  - **tsl** (integer) - Optional
  - **lsl** (number) - Optional
  - **ttp** (integer) - Optional
  - **ttpinc** (integer) - Optional
  - **slt** (any) - Optional
  - **slp** (object) - Optional
    - **m** (integer) - Optional
    - **tp** (any) - Optional
    - **pp** (any) - Optional
  - **p** (boolean) - Optional
  - **cf** (number) - Optional
  - **dsblinbap** (boolean) - Optional

### Request Example
```json
{
  "strategyId": 1,
  "exchangeId": 1,
  "exchangeAccountId": 3845,
  "exchangeMarketIds": 6,
  "name": "new bot",
  "desc": "test",
  "source": null,
  "params": {
    "border": {
      "bottom": 800,
      "top": 3000
    },
    "dsblin": false,
    "dsblinbtr": false,
    "obap": true,
    "gap": {
      "isg": 0.05,
      "maxS": 5,
      "minS": 1.5,
      "tog": 0.9
    },
    "gs": 0.38,
    "gsr": 1.05,
    "maxOp": 1500,
    "q": {
      "maxQ": 33,
      "minQ": 33,
      "qr": 1
    },
    "ris": false,
    "side": 1,
    "tr": {
      "mdTr": 10,
      "minToTr": 50,
      "tr": 1
    },
    "tsl": -100,
    "lsl": 0.3,
    "ttp": 50,
    "ttpinc": 10,
    "slt": null,
    "slp": {
      "m": 1,
      "tp": null,
      "pp": null
    },
    "p": true,
    "cf": 0.035,
    "dsblinbap": true
  }
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the created bot.
- **status** (integer) - The current status of the bot.
- **params** (object) - Bot specific parameters (same as request).
- **favourite** (boolean) - Indicates if the bot is a favorite.
- **demo** (boolean) - Indicates if the bot is in demo mode.
- **publicUrl** (string) - Public URL for the bot, if applicable.
- **createdAt** (string) - Timestamp of bot creation.
- **updatedAt** (string) - Timestamp of last bot update.
- **startedAt** (string) - Timestamp when the bot started.
- **stoppedAt** (string) - Timestamp when the bot stopped.
- **errorCode** (any) - Error code, if any.
- **externalError** (any) - External error message, if any.
- **strategyId** (integer) - The ID of the strategy used.
- **accountId** (integer) - The account ID.
- **exchangeId** (integer) - The ID of the exchange.
- **exchangeAccountId** (integer) - The ID of the exchange account.
- **exchangeMarketIds** (integer) - The ID of the exchange market.
- **name** (string) - The name of the bot.
- **desc** (string) - Description of the bot.
- **source** (any) - Source information.
- **preset** (object) - Preset configuration for the bot.
  - **level** (string) - The level of the preset.
  - **value** (integer) - The value of the preset.
  - **owner** (string) - The owner of the preset.

#### Response Example (200)
```json
{
  "id": 5574827624,
  "status": 0,
  "params": {
    "border": {
      "bottom": 800,
      "top": 3000
    },
    "dsblin": false,
    "dsblinbtr": false,
    "obap": true,
    "gap": {
      "isg": 0.05,
      "maxS": 5,
      "minS": 1.5,
      "tog": 0.9
    },
    "gs": 0.38,
    "gsr": 1.05,
    "maxOp": 1500,
    "q": {
      "maxQ": 33,
      "minQ": 33,
      "qr": 1
    },
    "ris": false,
    "side": 1,
    "tr": {
      "mdTr": 10,
      "minToTr": 50,
      "tr": 1
    },
    "tsl": -100,
    "lsl": 0.3,
    "ttp": 50,
    "ttpinc": 10,
    "slt": null,
    "slp": {
      "m": 1,
      "tp": null,
      "pp": null
    },
    "p": true,
    "cf": 0.035,
    "dsblinbap": true
  },
  "favourite": false,
  "demo": false,
  "publicUrl": "",
  "createdAt": "2024-02-03T20:25:23.005733Z",
  "updatedAt": "2024-02-03T20:25:23.005733Z",
  "startedAt": "2024-02-03T20:25:23.005733Z",
  "stoppedAt": "2024-02-03T20:25:23.005733Z",
  "errorCode": null,
  "externalError": null,
  "strategyId": 1,
  "accountId": 4039575436,
  "exchangeId": 1,
  "exchangeAccountId": 38892,
  "exchangeMarketIds": 6,
  "name": "redesign eth",
  "desc": "test",
  "source": null,
  "preset": {
    "level": "beginner",
    "value": 0,
    "owner": "string"
  }
}
```
```

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

### Response Sample for put/ws/private

Source: https://ginarea.org/api/doc

Example of a successful response from the put/ws/private endpoint.

```json
{
  "topic": "market.summaries",
  "insert": { },
  "update": { },
  "delete": { }
}
```

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

### Get Exchange All Markets Response Sample (JSON)

Source: https://ginarea.org/api/doc

Sample response for the GET /exchanges/markets endpoint, listing all available trading markets across exchanges.

```json
[
  {
    "code": "LTCUSDT",
    "name": "LTCUSDT",
    "minTradeQuantityPrimary": null,
    "maxTradeQuantityPrimary": null,
    "minTradeQuantitySecondary": 1,
    "maxTradeQuantitySecondary": 150000,
    "priceIncrement": 0.0001,
    "quantityIncrement": 1,
    "minTradePrice": 0.0001,
    "maxTradePrice": 199.9998,
    "defaultFee": 0.00055,
    "id": 16,
    "exchangeId": 1,
    "primaryCurrencyId": 8,
    "secondaryCurrencyId": 11,
    "accountType": "COIN_FUTURES",
    "lotSize": 1,
    "candles": true,
    "liquidations": false
  }
]
```

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

### Get Exchanges Response Sample (JSON)

Source: https://ginarea.org/api/doc

Sample response for the GET /exchanges endpoint, listing available trading exchanges.

```json
[
  {
    "id": 1,
    "code": "BYBT",
    "name": "Bybit",
    "twCode": "BYBT",
    "refUrl": "https://partner.bybit.com/b/GinArea_Official",
    "spotEnabled": true,
    "coinFuturesEnabled": true,
    "usdtFuturesEnabled": true,
    "apiPassRequired": false
  }
]
```

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

### Get Exchange Currencies Response Sample (JSON)

Source: https://ginarea.org/api/doc

Sample response for the GET /exchanges/currencies endpoint, listing supported currencies.

```json
[
  {
    "id": 1,
    "type": "FIAT",
    "code": "USD",
    "name": "USD"
  }
]
```

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

### Get Exchange Currency Response Sample (JSON)

Source: https://ginarea.org/api/doc

Sample response for the GET /exchanges/currencies/{currency_id} endpoint, detailing a specific currency.

```json
{
  "id": 1,
  "type": "FIAT",
  "code": "USD",
  "name": "USD"
}
```

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

### Enable 2FA Response Sample

Source: https://ginarea.org/api/doc

A sample response for the enable 2FA endpoint, providing a URL for the setup process.

```json
{
  "url": ""
}
```

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

### Bot Start Request Payload

Source: https://ginarea.org/api/doc

An empty JSON payload is used to initiate the start of a bot. This request is typically sent after configuring the bot's parameters.

```json
""
```

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

### Get bot params

Source: https://ginarea.org/api/doc

Retrieves the configuration parameters for a specific bot.

```APIDOC
## Get bot params 
##### Authorizations:
_bearerAuth_
##### path Parameters
bot_idrequired| number <int64>  
---|---  
### Responses
**200**
Successful response
**401**
Authorization error
**500**
Internal Server Error
get/bots/{bot_id}/params
https://ginarea.org/api/bots/{bot_id}/params
```

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

### Get Bot Strategies Sample

Source: https://ginarea.org/api/doc

Sample JSON response for retrieving a list of bot strategies. Includes strategy ID, name, description, and enabled status.

```json
[
  {
    "id": 1,
    "name": "grid",
    "description": "default grid",
    "enabled": true,
    "createdAt": "2023-04-15T10:16:11.422215Z"
  }

]
```

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

### Get Exchange Account Types Response Sample

Source: https://ginarea.org/api/doc

This is a sample JSON response for the 'Get exchange account types' endpoint, which returns a list of available account types as strings.

```json
[
  "string"

]
```

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

### Get Points Balance Response Sample

Source: https://ginarea.org/api/doc

Sample JSON response for retrieving points balance. Includes details like description, units, points, and withdraw status.

```json
[
  {
    "description": "SYSTEM",
    "units": 2702,
    "points": 0,
    "withdraw": false
}

]
```

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

### Get Top Bots

Source: https://ginarea.org/api/doc

Retrieves a list of top bots.

```APIDOC
## Get Top Bots

### Description
Retrieves a list of top bots. Requires bearer token authentication.

### Method
GET

### Endpoint
/api/bots/top

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the bot.
- **status** (integer) - The current status of the bot.
- **params** (object) - Bot specific parameters.
- **createdAt** (string) - Timestamp of bot creation.
- **updatedAt** (string) - Timestamp of last bot update.
- **startedAt** (string) - Timestamp when the bot started.
- **stoppedAt** (string) - Timestamp when the bot stopped.
- **strategyId** (integer) - The ID of the strategy used.
- **exchangeId** (integer) - The ID of the exchange.
- **exchangeMarketIds** (integer) - The ID of the exchange market.
- **name** (string) - The name of the bot.
- **desc** (string) - Description of the bot.
- **source** (any) - Source information.
- **stat** (object) - Statistics for the bot.
  - **currentProfit** (number) - Current profit of the bot.
  - **currentProfitUsdt** (number) - Current profit in USDT.
  - **balance** (number) - Current balance of the bot.

#### Response Example (200)
```json
[
  {
    "id": 5574827624,
    "status": 0,
    "params": {
      "border": {
        "bottom": 800,
        "top": 3000
      },
      "dsblin": false,
      "dsblinbtr": false,
      "obap": true,
      "gap": {
        "isg": 0.05,
        "maxS": 5,
        "minS": 1.5,
        "tog": 0.9
      },
      "gs": 0.38,
      "gsr": 1.05,
      "maxOp": 1500,
      "q": {
        "maxQ": 33,
        "minQ": 33,
        "qr": 1
      },
      "ris": false,
      "side": 1,
      "tr": {
        "mdTr": 10,
        "minToTr": 50,
        "tr": 1
      },
      "tsl": -100,
      "lsl": 0.3,
      "ttp": 50,
      "ttpinc": 10,
      "slt": null,
      "slp": {
        "m": 1,
        "tp": null,
        "pp": null
      },
      "p": true,
      "cf": 0.035,
      "dsblinbap": true
    },
    "createdAt": "2024-02-03T20:25:23.005733Z",
    "updatedAt": "2024-02-03T20:25:23.005733Z",
    "startedAt": "2024-02-03T20:25:23.005733Z",
    "stoppedAt": "2024-02-03T20:25:23.005733Z",
    "strategyId": 1,
    "exchangeId": 1,
    "exchangeMarketIds": 6,
    "name": "redesign eth",
    "desc": "test",
    "source": null,
    "stat": {
      "currentProfit": 345.229,
      "currentProfitUsdt": 345.229,
      "balance": 3848.21
    }
  }
]
```
```

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

### Enable 2FA (verify)

Source: https://ginarea.org/api/doc

Verifies the code provided during the two-factor authentication setup. Requires bearer authentication.

```APIDOC
## Enable 2FA (verify)

### Description
Verifies the code provided during the two-factor authentication setup.

### Method
POST

### Endpoint
/api/accounts/enableTwoFactor

### Authorizations
bearerAuth

### Request Body schema
application/json
```json
{
  "code": "string"
}
```

### Request Example
```json
{
  "code": 1234
}
```

### Responses
#### Success Response (200)
Successful response.

#### Error Response (401)
Authorization error.

#### Error Response (500)
Internal Server Error.
```

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

### Get Exchange Market Data Sample

Source: https://ginarea.org/api/doc

This is a sample JSON response for retrieving detailed information about a specific exchange market, including trading parameters and currency IDs.

```json
{
  "code": "LTCUSDT",
  "name": "LTCUSDT",
  "minTradeQuantityPrimary": null,
  "maxTradeQuantityPrimary": null,
  "minTradeQuantitySecondary": 1,
  "maxTradeQuantitySecondary": 150000,
  "priceIncrement": 0.0001,
  "quantityIncrement": 1,
  "minTradePrice": 0.0001,
  "maxTradePrice": 199.9998,
  "defaultFee": 0.00055,
  "id": 16,
  "exchangeId": 1,
  "primaryCurrencyId": 8,
  "secondaryCurrencyId": 11,
  "accountType": "COIN_FUTURES",
  "lotSize": 1,
  "candles": true,
  "liquidations": false

}
```

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

### Get All Accounts Response Sample

Source: https://ginarea.org/api/doc

This is a sample JSON response when retrieving a list of all accounts. The response is an array of account objects.

```json
[
  {
    "id": 4039575436,
    "name": null,
    "twoFactorEnable": false,
    "email": "example@mail.com",
    "emailConfirmed": true,
    "phoneNumber": null,
    "telegram": "872374747",
    "lang": "en",
    "privateLevel": 1,
    "createdAt": "2023-04-25T19:32:30.913224Z",
    "roleIds": [
      "1, 2"
]
}

]
```

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

### Get Bot Strategies

Source: https://ginarea.org/api/doc

Retrieves a list of available bot strategies. No authentication required.

```APIDOC
## Get bot strategies 
### Description
Retrieves a list of available bot strategies.
### Method
GET
### Endpoint
/api/bots/strategies
### Parameters
None
### Request Example
None
### Response
#### Success Response (200)
- **id** (number) - Unique identifier for the strategy
- **name** (string) - Name of the strategy
- **description** (string) - Description of the strategy
- **enabled** (boolean) - Indicates if the strategy is enabled
- **createdAt** (string) - Timestamp when the strategy was created
#### Response Example
```json
[
  {
    "id": 1,
    "name": "grid",
    "description": "default grid",
    "enabled": true,
    "createdAt": "2023-04-15T10:16:11.422215Z"
  }
]
```
```

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

### Get App Version Info Response Sample

Source: https://ginarea.org/api/doc

This JSON object represents a successful response containing the latest app version, minimum required version, and update information.

```json
{
  "latest_version": "1.0.0",
  "min_version": "1.0.0",
  "force_update": false,
  "message": "",
  "store_url": ""

}
```

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

### Get All Markets (V2 Format) Response Sample

Source: https://ginarea.org/api/doc

This JSON array represents a successful response containing detailed market information for all available markets.

```json
[
  {
    "id": 0,
    "exchangeId": 0,
    "code": "BTCUSDT",
    "name": "BTC/USDT",
    "accountType": "USDT_FUTURES",
    "primaryCurrency": {
      "id": 0,
      "name": "BTC"
},
    "secondaryCurrency": {
      "id": 0,
      "name": "BTC"
},
    "minQuantityPrimary": 0,
    "maxQuantityPrimary": 0,
    "minQuantitySecondary": 0,
    "maxQuantitySecondary": 0,
    "priceIncrement": 0,
    "quantityIncrement": 0,
    "minPrice": 0,
    "maxPrice": 0,
    "fee": 0,
    "lotSize": 0,
    "candles": true
}

]
```

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

### Get List of Bots

Source: https://ginarea.org/api/doc

Retrieves a list of configured bots. Requires bearer authentication.

```APIDOC
## Get list of bots 
### Description
Retrieves a list of configured bots.
### Method
GET
### Endpoint
/api/bots
### Parameters
None
### Request Example
None
### Response
#### Success Response (200)
- **id** (number) - Unique identifier for the bot
- **status** (number) - Current status of the bot
- **params** (object) - Configuration parameters for the bot
- **favourite** (boolean) - Indicates if the bot is a favorite
- **demo** (boolean) - Indicates if the bot is a demo bot
- **publicUrl** (string) - URL for public access to the bot (if applicable)
- **createdAt** (string) - Timestamp when the bot was created
- **updatedAt** (string) - Timestamp when the bot was last updated
- **startedAt** (string) - Timestamp when the bot was started
- **stoppedAt** (string) - Timestamp when the bot was stopped
- **errorCode** (any) - Error code if the bot encountered an error
- **externalError** (any) - External error message if applicable
- **strategyId** (number) - Identifier of the strategy used by the bot
- **accountId** (number) - Identifier of the user's account
- **exchangeId** (number) - Identifier of the exchange the bot is connected to
- **exchangeAccountId** (number) - Identifier of the specific exchange account
- **exchangeMarketIds** (number) - Identifier for the exchange market(s)
- **name** (string) - Name of the bot
- **desc** (string) - Description of the bot
- **source** (any) - Source of the bot configuration (if applicable)
- **preset** (object) - Preset configuration details for the bot
#### Response Example
```json
[
  {
    "id": 5574827624,
    "status": 0,
    "params": {
      "border": {
        "bottom": 800,
        "top": 3000
      },
      "dsblin": false,
      "dsblinbtr": false,
      "obap": true,
      "gap": {
        "isg": 0.05,
        "maxS": 5,
        "minS": 1.5,
        "tog": 0.9
      },
      "gs": 0.38,
      "gsr": 1.05,
      "maxOp": 1500,
      "q": {
        "maxQ": 33,
        "minQ": 33,
        "qr": 1
      },
      "ris": false,
      "side": 1,
      "tr": {
        "mdTr": 10,
        "minToTr": 50,
        "tr": 1
      },
      "tsl": -100,
      "lsl": 0.3,
      "ttp": 50,
      "ttpinc": 10,
      "slt": null,
      "slp": {
        "m": 1,
        "tp": null,
        "pp": null
      },
      "p": true,
      "cf": 0.035,
      "dsblinbap": true
    },
    "favourite": false,
    "demo": false,
    "publicUrl": "",
    "createdAt": "2024-02-03T20:25:23.005733Z",
    "updatedAt": "2024-02-03T20:25:23.005733Z",
    "startedAt": "2024-02-03T20:25:23.005733Z",
    "stoppedAt": "2024-02-03T20:25:23.005733Z",
    "errorCode": null,
    "externalError": null,
    "strategyId": 1,
    "accountId": 4039575436,
    "exchangeId": 1,
    "exchangeAccountId": 38892,
    "exchangeMarketIds": 6,
    "name": "redesign eth",
    "desc": "test",
    "source": null,
    "preset": {
      "level": "beginner",
      "value": 0,
      "owner": "string"
    }
  }
]
```
```

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

### Get all exchange summaries

Source: https://ginarea.org/api/doc

Retrieves a list of all exchange summaries. This endpoint does not require authentication.

```APIDOC
## Get all exchange summaries

### Description
Retrieves a list of all exchange summaries.

### Method
GET

### Endpoint
/api/exchanges/summaries

### Responses
#### Success Response (200)
Content type: application/json
Response Body:
[
  {
    "bid": 9.768,
    "ask": 9.77,
    "last": 9.77,
    "exchangeMarketId": 14,
    "exchangeId": 1,
    "accountType": "COIN_FUTURES"
  }
]

#### Error Response (500)
Internal Server Error
```

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

### Get All Markets (V2)

Source: https://ginarea.org/api/doc

Retrieves all markets with extended information, including currency details and candle availability. No authentication required.

```APIDOC
## GET /v2/exchanges/markets

### Description
Returns all markets with extended information including currency details and candle availability.

### Method
GET

### Endpoint
https://ginarea.org/api/v2/exchanges/markets

### Authorization
_noauthAuth_

### Response
#### Success Response (200)
- **id** (integer) - Market ID.
- **exchangeId** (integer) - Exchange ID.
- **code** (string) - Market code (e.g., BTCUSDT).
- **name** (string) - Market name (e.g., BTC/USDT).
- **accountType** (string) - Type of account (e.g., USDT_FUTURES).
- **primaryCurrency** (object) - Details of the primary currency.
  - **id** (integer) - Currency ID.
  - **name** (string) - Currency name.
- **secondaryCurrency** (object) - Details of the secondary currency.
  - **id** (integer) - Currency ID.
  - **name** (string) - Currency name.
- **minQuantityPrimary** (number) - Minimum quantity for the primary currency.
- **maxQuantityPrimary** (number) - Maximum quantity for the primary currency.
- **minQuantitySecondary** (number) - Minimum quantity for the secondary currency.
- **maxQuantitySecondary** (number) - Maximum quantity for the secondary currency.
- **priceIncrement** (number) - Price increment.
- **quantityIncrement** (number) - Quantity increment.
- **minPrice** (number) - Minimum price.
- **maxPrice** (number) - Maximum price.
- **fee** (number) - Trading fee.
- **lotSize** (number) - Lot size.
- **candles** (boolean) - Indicates if candle data is available.

### Response Example (200)
```json
[
  {
    "id": 0,
    "exchangeId": 0,
    "code": "BTCUSDT",
    "name": "BTC/USDT",
    "accountType": "USDT_FUTURES",
    "primaryCurrency": {
      "id": 0,
      "name": "BTC"
    },
    "secondaryCurrency": {
      "id": 0,
      "name": "BTC"
    },
    "minQuantityPrimary": 0,
    "maxQuantityPrimary": 0,
    "minQuantitySecondary": 0,
    "maxQuantitySecondary": 0,
    "priceIncrement": 0,
    "quantityIncrement": 0,
    "minPrice": 0,
    "maxPrice": 0,
    "fee": 0,
    "lotSize": 0,
    "candles": true
  }
]
```
```

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

### Enable 2FA (Verify) Request Payload

Source: https://ginarea.org/api/doc

Payload for verifying the 2FA setup, requiring a code.

```json
{
  "code": 1234
}
```

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

### Get App Version Info

Source: https://ginarea.org/api/doc

Retrieves version and update information for a specified mobile platform. No authentication required.

```APIDOC
## GET /app/version

### Description
Returns version and update information for the specified mobile platform.

### Method
GET

### Endpoint
https://ginarea.org/api/app/version

### Authorization
_noauthAuth_

### Query Parameters
- **platform** (string) - Required - Enum: "ios", "android". The mobile platform (e.g., platform=ios).
- **lang** (string) - Optional - Enum: "en", "ru". Message language (default: en).

### Response
#### Success Response (200)
- **latest_version** (string) - The latest available app version.
- **min_version** (string) - The minimum required app version.
- **force_update** (boolean) - Indicates if a force update is required.
- **message** (string) - Update message.
- **store_url** (string) - URL to the app store.

#### Error Response (400)
Invalid platform.

#### Error Response (500)
Internal Server Error.

### Response Example (200)
```json
{
  "latest_version": "1.0.0",
  "min_version": "1.0.0",
  "force_update": false,
  "message": "",
  "store_url": ""
}
```
```

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

### Get Account with VIP Info (V2) Response Sample

Source: https://ginarea.org/api/doc

This JSON structure represents a successful response for retrieving account information with VIP details.

```json
{
  "id": 4039575436,
  "name": "string",
  "twoFactorEnable": true,
  "email": "example@mail.com",
  "emailConfirmed": true,
  "phoneNumber": "string",
  "telegram": "string",
  "lang": "en",
  "privateLevel": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "roleIds": [
    0
],
  "vipInfo": {
    "id": 0,
    "pointsX": 0,
    "level": "Silver",
    "volume": 0,
    "nextLevel": {
      "id": 0,
      "level": "string",
      "threshold": 0,
      "pointsX": 0
}
}

}
```

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

### Get Account Referral Links Response

Source: https://ginarea.org/api/doc

Response structure for retrieving account referral links. Includes the link and a count.

```json
[
  {
    "link": "string",
    "count": 0
}
]
```

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

### Get Account Balances (V2 Format) Response Sample

Source: https://ginarea.org/api/doc

This JSON array shows a successful response for retrieving account balances across different exchanges and account types.

```json
[
  {
    "exchange": "Bybit",
    "accountType": "USDT_FUTURES",
    "coin": "USDT",
    "balance": 1250.5,
    "qtyIncrement": 0
}

]
```

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

### Create Account Request Payload

Source: https://ginarea.org/api/doc

Example JSON payload for creating a new account via the API. Requires the user's email and optionally accepts a referral link.

```json
{
  "email": "example@mail.com",
  "ref": null

}

```

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

### Get Account with VIP Info (V2)

Source: https://ginarea.org/api/doc

Retrieves account information including VIP level and volume data. Requires bearer token authentication.

```APIDOC
## GET /v2/accounts

### Description
Returns account information including VIP level details and volume data.

### Method
GET

### Endpoint
https://ginarea.org/api/v2/accounts

### Authorization
_bearerAuth_

### Response
#### Success Response (200)
- **id** (integer) - Account ID.
- **name** (string) - Account name.
- **twoFactorEnable** (boolean) - Indicates if two-factor authentication is enabled.
- **email** (string) - Account email address.
- **emailConfirmed** (boolean) - Indicates if the email is confirmed.
- **phoneNumber** (string) - Account phone number.
- **telegram** (string) - Telegram username.
- **lang** (string) - Preferred language.
- **privateLevel** (integer) - Private account level.
- **createdAt** (string) - Timestamp of account creation.
- **roleIds** (array) - Array of role IDs associated with the account.
- **vipInfo** (object) - VIP information.
  - **id** (integer) - VIP level ID.
  - **pointsX** (integer) - VIP points.
  - **level** (string) - VIP level name.
  - **volume** (integer) - Trading volume.
  - **nextLevel** (object) - Information about the next VIP level.
    - **id** (integer) - Next level ID.
    - **level** (string) - Next level name.
    - **threshold** (integer) - Threshold for the next level.
    - **pointsX** (integer) - Points required for the next level.

#### Error Response (401)
Authorization error.

### Response Example (200)
```json
{
  "id": 4039575436,
  "name": "string",
  "twoFactorEnable": true,
  "email": "example@mail.com",
  "emailConfirmed": true,
  "phoneNumber": "string",
  "telegram": "string",
  "lang": "en",
  "privateLevel": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "roleIds": [
    0
  ],
  "vipInfo": {
    "id": 0,
    "pointsX": 0,
    "level": "Silver",
    "volume": 0,
    "nextLevel": {
      "id": 0,
      "level": "string",
      "threshold": 0,
      "pointsX": 0
    }
  }
}
```
```

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

### Create Account (Quiet) Response Sample

Source: https://ginarea.org/api/doc

This is a sample JSON response upon successful creation of an account via the quiet endpoint.

```json
{
  "accountId": 4039575436

}
```

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

### Get List of Bots Sample

Source: https://ginarea.org/api/doc

Sample JSON response for retrieving a list of configured bots. It includes bot ID, status, parameters, and associated exchange and strategy information.

```json
[
  {
    "id": 5574827624,
    "status": 0,
    "params": {
      "border": {
        "bottom": 800,
        "top": 3000
},
      "dsblin": false,
      "dsblinbtr": false,
      "obap": true,
      "gap": {
        "isg": 0.05,
        "maxS": 5,
        "minS": 1.5,
        "tog": 0.9
},
      "gs": 0.38,
      "gsr": 1.05,
      "maxOp": 1500,
      "q": {
        "maxQ": 33,
        "minQ": 33,
        "qr": 1
},
      "ris": false,
      "side": 1,
      "tr": {
        "mdTr": 10,
        "minToTr": 50,
        "tr": 1
},
      "tsl": -100,
      "lsl": 0.3,
      "ttp": 50,
      "ttpinc": 10,
      "slt": null,
      "slp": {
        "m": 1,
        "tp": null,
        "pp": null
},
      "p": true,
      "cf": 0.035,
      "dsblinbap": true
    },
    "favourite": false,
    "demo": false,
    "publicUrl": "",
    "createdAt": "2024-02-03T20:25:23.005733Z",
    "updatedAt": "2024-02-03T20:25:23.005733Z",
    "startedAt": "2024-02-03T20:25:23.005733Z",
    "stoppedAt": "2024-02-03T20:25:23.005733Z",
    "errorCode": null,
    "externalError": null,
    "strategyId": 1,
    "accountId": 4039575436,
    "exchangeId": 1,
    "exchangeAccountId": 38892,
    "exchangeMarketIds": 6,
    "name": "redesign eth",
    "desc": "test",
    "source": null,
    "preset": {
      "level": "beginner",
      "value": 0,
      "owner": "string"
}
}

]
```

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

### Login Response Sample

Source: https://ginarea.org/api/doc

This is a sample JSON response after a successful login. It includes account details, access tokens, and refresh tokens.

```json
{
  "accountId": 4039575436,
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50Ijo0MTYxMjQwODUyLCJzZXNzaW9uIjoyMjMsInJvbGVzIjpbIm93bmVyIiwiYWRtaW4iLCJkZXZlbG9wZXIiXSwiZXhwIjoxNzA5NjQyMzE3fQ.cUPuydAIiRPy4wXswRJgfATPQ_KU5memDgc29Za1gmE",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uIjoyMjMsImV4cCI6MTcxMDE2MDcxN30.xp8asz31tRvuxHesNuHuPSWCwW2Jrm90t1ZaWAfmHfM",
  "email": "example@mail.com",
  "telegram": "872374747",
  "privateLevel": 1,
  "twoFactorEnable": false,
  "roleIds": [
    "1, 2"
],
  "lang": "en"

}
```

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

### Get Bot

Source: https://ginarea.org/api/doc

Retrieves details for a specific bot by its ID.

```APIDOC
## Get Bot

### Description
Retrieves details for a specific bot using its unique ID. Requires bearer token authentication.

### Method
GET

### Endpoint
/api/bots/{bot_id}

### Parameters
#### Path Parameters
- **bot_id** (number) - Required - The ID of the bot to retrieve.

### Request Example
None

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the bot.
- **status** (integer) - The current status of the bot.
- **params** (object) - Bot specific parameters.
- **favourite** (boolean) - Indicates if the bot is a favorite.
- **demo** (boolean) - Indicates if the bot is in demo mode.
- **publicUrl** (string) - Public URL for the bot, if applicable.
- **createdAt** (string) - Timestamp of bot creation.
- **updatedAt** (string) - Timestamp of last bot update.
- **startedAt** (string) - Timestamp when the bot started.
- **stoppedAt** (string) - Timestamp when the bot stopped.
- **errorCode** (any) - Error code, if any.
- **externalError** (any) - External error message, if any.
- **strategyId** (integer) - The ID of the strategy used.
- **accountId** (integer) - The account ID.
- **exchangeId** (integer) - The ID of the exchange.
- **exchangeAccountId** (integer) - The ID of the exchange account.
- **exchangeMarketIds** (integer) - The ID of the exchange market.
- **name** (string) - The name of the bot.
- **desc** (string) - Description of the bot.
- **source** (any) - Source information.
- **preset** (object) - Preset configuration for the bot.
  - **level** (string) - The level of the preset.
  - **value** (integer) - The value of the preset.
  - **owner** (string) - The owner of the preset.

#### Response Example (200)
```json
{
  "id": 5574827624,
  "status": 0,
  "params": {
    "border": {
      "bottom": 800,
      "top": 3000
    },
    "dsblin": false,
    "dsblinbtr": false,
    "obap": true,
    "gap": {
      "isg": 0.05,
      "maxS": 5,
      "minS": 1.5,
      "tog": 0.9
    },
    "gs": 0.38,
    "gsr": 1.05,
    "maxOp": 1500,
    "q": {
      "maxQ": 33,
      "minQ": 33,
      "qr": 1
    },
    "ris": false,
    "side": 1,
    "tr": {
      "mdTr": 10,
      "minToTr": 50,
      "tr": 1
    },
    "tsl": -100,
    "lsl": 0.3,
    "ttp": 50,
    "ttpinc": 10,
    "slt": null,
    "slp": {
      "m": 1,
      "tp": null,
      "pp": null
    },
    "p": true,
    "cf": 0.035,
    "dsblinbap": true
  },
  "favourite": false,
  "demo": false,
  "publicUrl": "",
  "createdAt": "2024-02-03T20:25:23.005733Z",
  "updatedAt": "2024-02-03T20:25:23.005733Z",
  "startedAt": "2024-02-03T20:25:23.005733Z",
  "stoppedAt": "2024-02-03T20:25:23.005733Z",
  "errorCode": null,
  "externalError": null,
  "strategyId": 1,
  "accountId": 4039575436,
  "exchangeId": 1,
  "exchangeAccountId": 38892,
  "exchangeMarketIds": 6,
  "name": "redesign eth",
  "desc": "test",
  "source": null,
  "preset": {
    "level": "beginner",
    "value": 0,
    "owner": "string"
  }
}
```
```

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

### Create Exchange Account Response Sample

Source: https://ginarea.org/api/doc

This JSON sample represents a successful response after creating a new exchange account, returning the details of the newly created account.

```json
{
  "externalAccountId": 33506436,
  "externalAccountType": 2,
  "externalInviterId": 0,
  "externalAffiliateId": 0,
  "externalLevel": "No VIP",
  "expireAt": null,
  "createdAt": "2023-11-11T07:55:28Z",
  "id": 4,
  "accountId": 3626962684,
  "exchangeId": 1,
  "type": "COIN_FUTURES",
  "name": "Bybit",
  "apiKeyName": "WINz********4eTg",
  "apiKeyExpireSoon": false,
  "disabled": false,
  "disableReason": null,
  "problemDescription": null,
  "maxRunningBots": 10,
  "maxCreatedBots": 100,
  "updatedAt": "2023-11-11T07:56:35.374921Z"

}
```
Tokens:
Raw