Raydar API

A robust data infrastructure providing everything you need for crypto.

airdrops

ListMyAirdrops

Url: https://api.test.raydar.app/swagger/index.html#/airdrops/ListMyAirdrops
The endpoint used is /v1/airdrops/me [get]
Returns airdrop earnings for the authenticated user, grouped by method with completion status

Response Example:

{
  "items": [
    {
      "completed": true,
      "earnings": [
        {
          "amount": "string",
          "createdAt": "string",
          "meta": null
        }
      ],
      "method": "REGISTER,CONNECT,PAY,REFER,SHARE,B2B",
      "methodCap": 0,
      "methodTotal": "string"
    }
  ],
  "itemsCount": 0,
  "totalEarn": "string"
}

GetAirdropSummary

Url: https://api.test.raydar.app/swagger/index.html#/airdrops/GetAirdropSummary
The endpoint used is /v1/airdrops/summary [get]
Returns aggregated airdrop stats (earned-only)

Response Example:

{
  "methodTotals": [
    {
      "amount": "string",
      "method": "REGISTER,CONNECT,PAY,REFER,SHARE,B2B"
    }
  ],
  "totalCountries": 0,
  "totalDistributed": "string",
  "totalRecipients": 0,
  "totalUsers": 0
}

alarms

GetAlarms

Url: https://api.test.raydar.app/swagger/index.html#/alarms/GetAlarms
The endpoint used is /v1/alarms [get]
This endpoint Returns a list of the user’s alarms
Query parameters accepted: offset, limit, isActive, and isTrigger.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- isActive: Active alarm
- isTrigger: Trigger alarm

Response Example:

{
  "alarms": [
    {
      "alarmType": "string",
      "asset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "condition": "string",
      "createdAt": 0,
      "currentValue": "string",
      "exchanges": [
        {
          "baseUrl": "string",
          "credentialInfo": {},
          "exchangeBaseAsset": "string",
          "exchangeIcon": "string",
          "exchangeLogo": "string",
          "id": 0,
          "info": {},
          "mobileIcon": "string",
          "mobileLogo": "string",
          "name": "string"
        }
      ],
      "id": 0,
      "isActive": true,
      "isTrigger": true,
      "symbol": {
        "baseAsset": 0,
        "id": 0,
        "name": "string",
        "targetAsset": 0
      },
      "updatedAt": 0,
      "userId": 0,
      "value": "string",
      "valueType": "string"
    }
  ],
  "itemCount": 0
}

CreateAlarm

Url: https://api.test.raydar.app/swagger/index.html#/alarms/CreateAlarm
The endpoint used is /v1/alarms/ [post]
This endpoint allows for creating an alarm.
Body parameters accepted: request.
- request: Updated alarm

Response Example:

{
  "alarmType": "string",
  "asset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "condition": "string",
  "createdAt": 0,
  "currentValue": "string",
  "exchanges": [
    {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    }
  ],
  "id": 0,
  "isActive": true,
  "isTrigger": true,
  "symbol": {
    "baseAsset": 0,
    "id": 0,
    "name": "string",
    "targetAsset": 0
  },
  "updatedAt": 0,
  "userId": 0,
  "value": "string",
  "valueType": "string"
}

GetAlarm

Url: https://api.test.raydar.app/swagger/index.html#/alarms/GetAlarm
The endpoint used is /v1/alarms/{id} [get]
This endpoint allows for retrieving a specific alarm by its ID.
Path parameters accepted: id.
- id: Alarm ID

Response Example:

{
  "alarmType": "string",
  "asset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "condition": "string",
  "createdAt": 0,
  "currentValue": "string",
  "exchanges": [
    {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    }
  ],
  "id": 0,
  "isActive": true,
  "isTrigger": true,
  "symbol": {
    "baseAsset": 0,
    "id": 0,
    "name": "string",
    "targetAsset": 0
  },
  "updatedAt": 0,
  "userId": 0,
  "value": "string",
  "valueType": "string"
}

UpdateAlarm

Url: https://api.test.raydar.app/swagger/index.html#/alarms/UpdateAlarm
The endpoint used is /v1/alarms/{id} [put]
This endpoint allows for updating a specific alarm by its ID.
Path parameters accepted: id.
- id: Alarm ID
Body parameters accepted: request.
- request: Updated alarm

Response Example:

{
  "alarmType": "string",
  "asset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "condition": "string",
  "createdAt": 0,
  "currentValue": "string",
  "exchanges": [
    {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    }
  ],
  "id": 0,
  "isActive": true,
  "isTrigger": true,
  "symbol": {
    "baseAsset": 0,
    "id": 0,
    "name": "string",
    "targetAsset": 0
  },
  "updatedAt": 0,
  "userId": 0,
  "value": "string",
  "valueType": "string"
}

DeleteAlarm

Url: https://api.test.raydar.app/swagger/index.html#/alarms/DeleteAlarm
The endpoint used is /v1/alarms/{id} [delete]
This endpoint allows for deleting a specific alarm by its ID.
Path parameters accepted: id.
- id: Alarm ID

Response Example:

"string"

assets

GetAssets

Url: https://api.test.raydar.app/swagger/index.html#/assets/GetAssets
The endpoint used is /v1/assets [get]
This endpoint allows for getting assets with optional filtering, pagination, and sorting. You can search by asset code, paginate results, and sort by asset code.
Query parameters accepted: offset, limit, search, and sort.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- search: Search asset by code
- sort: Sort By enums(code, code-, name, name-)

Response Example:

{
  "assets": [
    {
      "code": "string",
      "icon": "string",
      "id": 0,
      "name": "string"
    }
  ],
  "itemCount": 0
}

GetAsset

Url: https://api.test.raydar.app/swagger/index.html#/assets/GetAsset
The endpoint used is /v1/assets/{id} [get]
This endpoint allows for retrieving a specific asset by its ID.
Path parameters accepted: id.
- id: Asset ID

Response Example:

{
  "code": "string",
  "icon": "string",
  "id": 0,
  "name": "string"
}

users

LoginUser

Url: https://api.test.raydar.app/swagger/index.html#/users/LoginUser
The endpoint used is /v1/auth/login [post]
This endpoint allows users to authenticate by providing valid credentials.
Body parameters accepted: request.
- request: Login request body containing username and password

Response Example:

{
  "access_token": "string",
  "expires_in": 0,
  "id_token": "string",
  "not-before-policy": 0,
  "refresh_expires_in": 0,
  "refresh_token": "string",
  "scope": "string",
  "session_state": "string",
  "token_type": "string"
}

LogOut

Url: https://api.test.raydar.app/swagger/index.html#/users/LogOut
The endpoint used is /v1/auth/logout [post]
This endpoint allows the authenticated user to log out. It invalidates the provided refresh token, preventing further use.
Body parameters accepted: request.
- request: Request body containing the refresh token to invalidate

Response Example:

"string"

RefreshToken

Url: https://api.test.raydar.app/swagger/index.html#/users/RefreshToken
The endpoint used is /v1/auth/refresh [post]
This endpoint allows users to refresh their JWT token using a valid refresh token.
Body parameters accepted: request.
- request: Request body containing the refresh token

Response Example:

{
  "access_token": "string",
  "expires_in": 0,
  "id_token": "string",
  "not-before-policy": 0,
  "refresh_expires_in": 0,
  "refresh_token": "string",
  "scope": "string",
  "session_state": "string",
  "token_type": "string"
}

CreateUser

Url: https://api.test.raydar.app/swagger/index.html#/users/CreateUser
The endpoint used is /v1/auth/users [post]
This endpoint allows for creating a new user by providing necessary details such as name, email, and password.
Body parameters accepted: request.
- request: User create body

Response Example:

{
  "accountType": "string",
  "allowMailNotifications": true,
  "country": "string",
  "currency": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string",
    "symbol": "string"
  },
  "email": "string",
  "firstname": "string",
  "id": 0,
  "isMarried": true,
  "lastLoginAt": "string",
  "lastLoginDevice": "string",
  "lastname": "string",
  "phone": "string",
  "referenceBy": "string",
  "referenceNo": "string",
  "region": 0,
  "totalTokens": "string"
}

GetUser

Url: https://api.test.raydar.app/swagger/index.html#/users/GetUser
The endpoint used is /v1/users/me [get]
This endpoint retrieves the details of the currently authenticated user.

Response Example:

{
  "accountType": "string",
  "allowMailNotifications": true,
  "country": "string",
  "currency": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string",
    "symbol": "string"
  },
  "email": "string",
  "firstname": "string",
  "id": 0,
  "isMarried": true,
  "lastLoginAt": "string",
  "lastLoginDevice": "string",
  "lastname": "string",
  "phone": "string",
  "referenceBy": "string",
  "referenceNo": "string",
  "region": 0,
  "totalTokens": "string"
}

UpdateUser

Url: https://api.test.raydar.app/swagger/index.html#/users/UpdateUser
The endpoint used is /v1/users/me [put]
This endpoint allows the authenticated user to update their personal details such as name, phone, or other editable fields.
Body parameters accepted: request.
- request: Request body containing fields to update

Response Example:

{
  "accountType": "string",
  "allowMailNotifications": true,
  "country": "string",
  "currency": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string",
    "symbol": "string"
  },
  "email": "string",
  "firstname": "string",
  "id": 0,
  "isMarried": true,
  "lastLoginAt": "string",
  "lastLoginDevice": "string",
  "lastname": "string",
  "phone": "string",
  "referenceBy": "string",
  "referenceNo": "string",
  "region": 0,
  "totalTokens": "string"
}

DeleteUser

Url: https://api.test.raydar.app/swagger/index.html#/users/DeleteUser
The endpoint used is /v1/users/me [delete]
This endpoint allows the authenticated user to delete their account permanently.
Body parameters accepted: request.
- request: Request body containing user credentials or additional confirmation information

Response Example:

"string"

MyArbitrage

Url: https://api.test.raydar.app/swagger/index.html#/users/MyArbitrage
The endpoint used is /v1/users/me/arbitrage [get]
This endpoint allows for getting the arbitrage details of a user, including the balances across multiple exchanges and the total available for each coin.
Query parameters accepted: offset, limit, and search.
- offset: Page offset default(0)
- limit: Page limit default(10)
- search: Search by asset code

Response Example:

{
  "arbitrage": [
    {
      "coin": {
        "allExchangesTotal": "string",
        "asset": {
          "code": "string",
          "icon": "string",
          "id": 0,
          "name": "string"
        }
      },
      "exchanges": [
        {
          "coinTotal": "string",
          "exchange": {
            "baseUrl": "string",
            "credentialInfo": {},
            "exchangeBaseAsset": "string",
            "exchangeIcon": "string",
            "exchangeLogo": "string",
            "id": 0,
            "info": {},
            "mobileIcon": "string",
            "mobileLogo": "string",
            "name": "string"
          }
        }
      ]
    }
  ],
  "itemCount": 0
}

AssetsOverview

Url: https://api.test.raydar.app/swagger/index.html#/users/AssetsOverview
The endpoint used is /v1/users/me/assets/overview [get]
This endpoint retrieves an overview of the user’s assets, including profitable and loss coins, open and closed orders, and the total coin count. Optionally, an exchange ID can be provided to filter the overview by exchange.
Query parameters accepted: exchangeId, and walletId.
- exchangeId: Exchange ID
- walletId: Wallet ID

Response Example:

{
  "closeOrdersCount": 0,
  "lossCoinCount": 0,
  "openOrdersCount": 0,
  "profitableCoinCount": 0,
  "totalCoinCount": 0,
  "totalLossAmount": "string",
  "totalProfitAmount": "string"
}

MyBalances

Url: https://api.test.raydar.app/swagger/index.html#/users/MyBalances
The endpoint used is /v1/users/me/balances [get]
This endpoint allows for getting the balances of a user.
Query parameters accepted: offset, limit, walletId, type, coin, and sort.
- offset: Page offset default(0)
- limit: Page limit default(10)
- walletId: Wallet ID
- type: Balance Type enums(SPOT, MARGIN, FUTURE, EARN)
- coin: Coin Code
- sort: Sort By enums(total, total-, amount, amount-, apl, apl-, avgCost, avgCost-, totalCost, totalCost-, aplPercentage, aplPercentage-, assetName, assetName-, assetCode, assetCode-)

Response Example:

{
  "balances": [
    {
      "amount": "string",
      "amountBtc": "string",
      "apl": "string",
      "aplPercentage": "string",
      "asset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "available": "string",
      "avgCost": "string",
      "balanceType": "string",
      "closeOrdersCount": 0,
      "exchangeId": 0,
      "extraCoinsNeededCount": "string",
      "extraCoinsNeededProfit": "string",
      "id": 0,
      "isManual": true,
      "openOrdersCount": 0,
      "total": "string",
      "totalCost": "string",
      "volume24H": "string",
      "volumeBtc24H": "string",
      "wallet": {
        "exchange": {
          "baseUrl": "string",
          "credentialInfo": {},
          "exchangeBaseAsset": "string",
          "exchangeIcon": "string",
          "exchangeLogo": "string",
          "id": 0,
          "info": {},
          "mobileIcon": "string",
          "mobileLogo": "string",
          "name": "string"
        },
        "id": 0,
        "name": "string"
      }
    }
  ],
  "itemCount": 0
}

MyCoins

Url: https://api.test.raydar.app/swagger/index.html#/users/MyCoins
The endpoint used is /v1/users/me/coins [get]
This endpoint retrieves the list of coins associated with the authenticated user. It allows for pagination and filtering by coin ID, exchange ID, wallet ID, balance type, and sorting by various fields.
Query parameters accepted: offset, limit, coin, exchangeId, walletId, type, and sort.
- offset: Page offset default(0)
- limit: Page limit default(10)
- coin: Coin Code
- exchangeId: Exchange ID
- walletId: Wallet ID
- type: Balance type enums(SPOT, MARGIN, FUTURE, EARN)
- sort: Sort by field default(amount-) enums(total, total-, amount, amount-, exchangeCount, exchangeCount-, apl, apl-, avgCost, avgCost-, totalCost, totalCost-, aplPercentage, aplPercentage-, assetName, assetName-, assetCode, assetCode-)

Response Example:

{
  "coins": [
    {
      "amount": "string",
      "amountBtc": 0,
      "apl": "string",
      "aplPercentage": "string",
      "avgCost": "string",
      "code": "string",
      "exchangeCount": 0,
      "exchangeUrls": [
        "string"
      ],
      "hasAlarm": true,
      "icon": "string",
      "id": 0,
      "isFavorite": true,
      "lastTradeTime": 0,
      "name": "string",
      "openOrdersCount": 0,
      "total": "string",
      "totalCost": "string",
      "tradePrice": "string"
    }
  ],
  "itemCount": 0
}

MyFavoriteCoins

Url: https://api.test.raydar.app/swagger/index.html#/users/MyFavoriteCoins
The endpoint used is /v1/users/me/coins/favorites [get]
This endpoint allows an authenticated user to retrieve their list of favorite coins.

Response Example:

{
  "assets": [
    {
      "code": "string",
      "icon": "string",
      "id": 0,
      "name": "string"
    }
  ],
  "itemCount": 0
}

AddFavoriteCoins

Url: https://api.test.raydar.app/swagger/index.html#/users/AddFavoriteCoins
The endpoint used is /v1/users/me/coins/favorites [post]
This endpoint allows an authenticated user to add a coin to their list of favorite coins.
Body parameters accepted: request.
- request: Request body to specify the coin to add to favorites

Response Example:

{
  "code": 0,
  "error": "string"
}

RemoveFavoriteCoins

Url: https://api.test.raydar.app/swagger/index.html#/users/RemoveFavoriteCoins
The endpoint used is /v1/users/me/coins/favorites/{id} [delete]
This endpoint allows an authenticated user to remove a coin from their favorites.
Path parameters accepted: id.
- id: Coin ID to be removed

Response Example:

"string"

MyPopularCoins

Url: https://api.test.raydar.app/swagger/index.html#/users/MyPopularCoins
The endpoint used is /v1/users/me/coins/popular [get]
This endpoint retrieves a list of popular coins for the authenticated user.

Response Example:

{
  "assets": [
    {
      "code": "string",
      "icon": "string",
      "id": 0,
      "name": "string"
    }
  ],
  "itemCount": 0
}

MyCoin

Url: https://api.test.raydar.app/swagger/index.html#/users/MyCoin
The endpoint used is /v1/users/me/coins/{code} [get]
This endpoint allows for retrieving details of a specific coin.
Path parameters accepted: code.
- code: Coin Code

Response Example:

{
  "coins": [
    {
      "amount": "string",
      "amountBtc": "string",
      "code": "string",
      "exchange": {
        "baseUrl": "string",
        "credentialInfo": {},
        "exchangeBaseAsset": "string",
        "exchangeIcon": "string",
        "exchangeLogo": "string",
        "id": 0,
        "info": {},
        "mobileIcon": "string",
        "mobileLogo": "string",
        "name": "string"
      },
      "icon": "string",
      "id": 0,
      "isFavorite": true,
      "name": "string",
      "total": "string"
    }
  ]
}

MyAssetFilters

Url: https://api.test.raydar.app/swagger/index.html#/users/MyAssetFilters
The endpoint used is /v1/users/me/coins/{type}/filters [get]
This endpoint retrieves assets filtered by a specified type, such as balance, order, or trade.
Path parameters accepted: type.
- type: Filter Type enums(balance, order, trade)

Response Example:

{
  "assets": [
    {
      "code": "string",
      "icon": "string",
      "id": 0,
      "name": "string"
    }
  ],
  "itemCount": 0
}

DepositWithdrawalChart

Url: https://api.test.raydar.app/swagger/index.html#/users/DepositWithdrawalChart
The endpoint used is /v1/users/me/deposit-withdrawal/chart [get]
This endpoint retrieves a chart showing the user’s deposit and withdrawal activities over time. It provides a monthly summary of deposits and withdrawals, with the option to convert amounts to the user’s preferred currency.

Response Example:

{
  "data": [
    {
      "deposit": "string",
      "name": "string",
      "withdraw": "string"
    }
  ]
}

MyExchanges

Url: https://api.test.raydar.app/swagger/index.html#/users/MyExchanges
The endpoint used is /v1/users/me/exchanges [get]
This endpoint retrieves details of user’s exchanges based on given filters and sorting.
Query parameters accepted: offset, limit, coin, exchangeId, and sort.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- coin: Coin Code
- exchangeId: Exchange ID
- sort: Sort by field default(amount-) enums(amount, amount-, coinCount, coinCount-, apl, apl-, aplPercentage, aplPercentage-, avgCost, avgCost-, totalCost, totalCost-, name, name-)

Response Example:

{
  "exchanges": [
    {
      "amount": "string",
      "amountBtc": "string",
      "apl": "string",
      "aplPercentage": "string",
      "avgCost": "string",
      "closeOrderCount": 0,
      "coinCount": 0,
      "coinIcons": [
        "string"
      ],
      "icon": "string",
      "id": 0,
      "logo": "string",
      "lossCoinCount": 0,
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string",
      "openOrderCount": 0,
      "price": "string",
      "profitableCoinCount": 0,
      "totalCoin": "string",
      "totalCost": "string",
      "totalLossAmount": "string",
      "totalProfitAmount": "string"
    }
  ],
  "itemCount": 0
}

GetDataImports

Url: https://api.test.raydar.app/swagger/index.html#/users/GetDataImports
The endpoint used is /v1/users/me/imports [get]
This endpoint retrieves manual data import requests.
Query parameters accepted: offset, limit, and dataType.
- offset: Page offset default(0)
- limit: Page limit default(10)
- dataType: Data Import Type enums(trade, transferIn, transferOut)

Response Example:

{
  "dataImports": [
    {
      "completedAt": 0,
      "createdAt": 0,
      "dataType": "string",
      "exchangeName": "string",
      "failReason": "string",
      "id": 0,
      "retryCount": 0,
      "status": "string",
      "totalRecord": 0,
      "updatedAt": 0,
      "walletId": 0
    }
  ],
  "itemCount": 0
}

ImportData

Url: https://api.test.raydar.app/swagger/index.html#/users/ImportData
The endpoint used is /v1/users/me/imports/{walletId} [post]
This endpoint allows users to import manual transaction data from a CSV or XLS file into a specified wallet.
Path parameters accepted: walletId.
- walletId: Wallet ID to associate with the imported data
Formdata parameters accepted: walletType, startingYear, dateLayout, dataType, and file.
- walletType: Wallet Type enums(SPOT, MARGIN, FUTURE)
- startingYear: Year to start importing
- dateLayout: Date layout enums(DD-MM-YY, DD-MM-YYYY, MM-DD-YY, MM-DD-YYYY, YY-MM-DD, YYYY-MM-DD)
- dataType: Data Type enums(trade, transferIn, transferOut)
- file: CSV or XLS or XLSX file

Response Example:

{
  "completedAt": 0,
  "createdAt": 0,
  "dataType": "string",
  "exchangeName": "string",
  "failReason": "string",
  "id": 0,
  "retryCount": 0,
  "status": "string",
  "totalRecord": 0,
  "updatedAt": 0,
  "walletId": 0
}

MyMembership

Url: https://api.test.raydar.app/swagger/index.html#/users/MyMembership
The endpoint used is /v1/users/me/membership [get]
This endpoint allows for fetching the active membership details of a user, including the expiration date and related information.

Response Example:

{
  "expirationAt": 0,
  "id": 0,
  "isActive": true,
  "membership": {
    "attributes": {},
    "basePrice": "string",
    "description": {},
    "id": 0,
    "isActive": true,
    "name": "string",
    "period": 0,
    "price": "string",
    "type": "string"
  },
  "price": "string",
  "userId": 0
}

GetUserNotifications

Url: https://api.test.raydar.app/swagger/index.html#/users/GetUserNotifications
The endpoint used is /v1/users/me/notifications [get]
This endpoint retrieves user notifications.
Query parameters accepted: offset, limit, and isRead.
- offset: Page offset default(0)
- limit: Page limit default(10)
- isRead: Page limit

Response Example:

{
  "itemCount": 0,
  "notifications": [
    {
      "createdAt": 0,
      "id": 0,
      "isRead": true,
      "message": "string",
      "updatedAt": 0,
      "userId": 0
    }
  ]
}

ReadAllNotification

Url: https://api.test.raydar.app/swagger/index.html#/users/ReadAllNotification
The endpoint used is /v1/users/me/notifications/read-all [get]
Mark all notifications as read for a user

Response Example:

"string"

ReadNotification

Url: https://api.test.raydar.app/swagger/index.html#/users/ReadNotification
The endpoint used is /v1/users/me/notifications/{id}/read [get]
Mark notification as read by ID for a user
Path parameters accepted: id.
- id: UserNotification ID to be read

Response Example:

"string"

UpdateUserPassword

Url: https://api.test.raydar.app/swagger/index.html#/users/UpdateUserPassword
The endpoint used is /v1/users/me/password [put]
This endpoint allows the authenticated user to update their password.
Body parameters accepted: request.
- request: Request body containing current and new password

Response Example:

"string"

MyPayments

Url: https://api.test.raydar.app/swagger/index.html#/users/MyPayments
The endpoint used is /v1/users/me/payments [get]
This endpoint allows for retrieving the payment transactions of a user, with pagination support.
Query parameters accepted: offset, and limit.
- offset: Page offset default(0)
- limit: Page limit default(10)

Response Example:

{
  "itemCount": 0,
  "transactions": [
    {
      "createdAt": 0,
      "id": 0,
      "referenceNo": "string",
      "status": "string",
      "updatedAt": 0
    }
  ]
}

MyStats

Url: https://api.test.raydar.app/swagger/index.html#/users/MyStats
The endpoint used is /v1/users/me/stats [get]
This endpoint allows for retrieving the statistics of a user.

Response Example:

{
  "dailySyncCount": 0,
  "id": 0,
  "membershipDailySyncCount": 0,
  "membershipTransactionCount": 0,
  "membershipWalletCount": 0,
  "syncCount": 0,
  "transactionCount": 0,
  "userId": 0,
  "walletCount": 0
}

UnsubscribeUser

Url: https://api.test.raydar.app/swagger/index.html#/users/UnsubscribeUser
The endpoint used is /v1/users/unsubscribe/{channel} [get]
Unsubscribe user using token from email
Path parameters accepted: channel.
- channel: Unsubscribe Channel (e.g., email)
Query parameters accepted: token.
- token: Unsubscribe Token

Response Example:

{
  "message": "string"
}

calculation

CalcNewCoinScenario

Url: https://api.test.raydar.app/swagger/index.html#/calculation/CalcNewCoinScenario
The endpoint used is /v1/calculate/exit/loss [post]
This endpoint calculates the updated average cost per coin and potential profit after purchasing additional coins.
Body parameters accepted: request.
- request: Calculation request data

Response Example:

{
  "avgCost": "string",
  "profit": "string"
}

coinpays

CoinpaysCallback

Url: https://api.test.raydar.app/swagger/index.html#/coinpays/CoinpaysCallback
The endpoint used is /v1/coinpays/callback [post]
This endpoint processes the callback from Coinpays and updates the payment status accordingly.
Body parameters accepted: request.
- request: Coinpays callback body

Response Example:

"string"

GetPaymentToken

Url: https://api.test.raydar.app/swagger/index.html#/coinpays/GetPaymentToken
The endpoint used is /v1/coinpays/token [get]
This endpoint generates a payment token for Coinpays based on the membership ID.
Query parameters accepted: membershipId.
- membershipId: Membership ID

Response Example:

{
  "status": "string",
  "token": "string"
}

currencies

GetCurrencies

Url: https://api.test.raydar.app/swagger/index.html#/currencies/GetCurrencies
The endpoint used is /v1/currencies [get]
This endpoint retrieves all currencies. It supports currencies traded at the European Central Bank.

Response Example:

{
  "currencies": [
    {
      "code": "string",
      "icon": "string",
      "id": 0,
      "name": "string",
      "symbol": "string"
    }
  ]
}

exchanges

GetExchanges

Url: https://api.test.raydar.app/swagger/index.html#/exchanges/GetExchanges
The endpoint used is /v1/exchanges [get]
This endpoint retrieves a list of all exchanges, with options for pagination, search, and sorting.
Query parameters accepted: offset, limit, search, and sort.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- search: Search by exchange name
- sort: Sort By enums(name, name-)

Response Example:

{
  "exchanges": [
    {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    }
  ],
  "itemCount": 0
}

GetExchangeOrderParams

Url: https://api.test.raydar.app/swagger/index.html#/exchanges/GetExchangeOrderParams
The endpoint used is /v1/exchanges/{exchange}/order-params [get]
Returns markets, order types, per-market params and supported enum values for an exchange.
Path parameters accepted: exchange.
- exchange: Exchange name enums(binance, binance-tr, bingx, bitexen, bitfinex, bitget, bitmart, bitstamp, btcturk, bybit, coin-tr, coinbase, coinbase-futures, coinw, cryptocom, gateio, gate-tr, gemini, gemini-futures, htx, icrypex, kraken, kraken-futures, kucoin, mexc, okx, okx-tr, probit, whitebit)

Response Example:

{
  "exchange": "string",
  "markets": [
    "string"
  ],
  "orderTypes": [
    "string"
  ],
  "params": {},
  "supportedEnums": {}
}

GetExchange

Url: https://api.test.raydar.app/swagger/index.html#/exchanges/GetExchange
The endpoint used is /v1/exchanges/{id} [get]
This endpoint retrieves a single exchange by its ID.
Path parameters accepted: id.
- id: Exchange ID

Response Example:

{
  "baseUrl": "string",
  "credentialInfo": {},
  "exchangeBaseAsset": "string",
  "exchangeIcon": "string",
  "exchangeLogo": "string",
  "id": 0,
  "info": {},
  "mobileIcon": "string",
  "mobileLogo": "string",
  "name": "string"
}

health

GetAllExchangeHealth

Url: https://api.test.raydar.app/swagger/index.html#/health/GetAllExchangeHealth
The endpoint used is /v1/health/exchanges [get]
Returns health states for all exchanges

Response Example:

{
  "records": [
    {
      "checkedAt": 0,
      "icon": "string",
      "name": "string",
      "status": "string"
    }
  ]
}

GetExchangeHealth

Url: https://api.test.raydar.app/swagger/index.html#/health/GetExchangeHealth
The endpoint used is /v1/health/exchanges/{exchangeId} [get]
Returns current health state for the specified exchange.
Path parameters accepted: exchangeId.
- exchangeId: Exchange ID

Response Example:

{
  "record": {
    "checkedAt": 0,
    "icon": "string",
    "name": "string",
    "status": "string"
  }
}

manual-balances

CreateManualBalance

Url: https://api.test.raydar.app/swagger/index.html#/manual-balances/CreateManualBalance
The endpoint used is /v1/manual-balances [post]
This endpoint allows for creating a new balance for manual wallets.
Body parameters accepted: request.
- request: Balance create body

Response Example:

{
  "amount": "string",
  "amountBtc": "string",
  "apl": "string",
  "aplPercentage": "string",
  "asset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "available": "string",
  "avgCost": "string",
  "balanceType": "string",
  "closeOrdersCount": 0,
  "exchangeId": 0,
  "extraCoinsNeededCount": "string",
  "extraCoinsNeededProfit": "string",
  "id": 0,
  "isManual": true,
  "openOrdersCount": 0,
  "total": "string",
  "totalCost": "string",
  "volume24H": "string",
  "volumeBtc24H": "string",
  "wallet": {
    "exchange": {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    },
    "id": 0,
    "name": "string"
  }
}

GetManualBalance

Url: https://api.test.raydar.app/swagger/index.html#/manual-balances/GetManualBalance
The endpoint used is /v1/manual-balances/{id} [get]
This endpoint allows for getting an existing manual balance.
Query parameters accepted: walletId.
- walletId: Wallet ID
Path parameters accepted: id.
- id: Balance ID

Response Example:

{
  "amount": "string",
  "amountBtc": "string",
  "apl": "string",
  "aplPercentage": "string",
  "asset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "available": "string",
  "avgCost": "string",
  "balanceType": "string",
  "closeOrdersCount": 0,
  "exchangeId": 0,
  "extraCoinsNeededCount": "string",
  "extraCoinsNeededProfit": "string",
  "id": 0,
  "isManual": true,
  "openOrdersCount": 0,
  "total": "string",
  "totalCost": "string",
  "volume24H": "string",
  "volumeBtc24H": "string",
  "wallet": {
    "exchange": {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    },
    "id": 0,
    "name": "string"
  }
}

UpdateManualBalance

Url: https://api.test.raydar.app/swagger/index.html#/manual-balances/UpdateManualBalance
The endpoint used is /v1/manual-balances/{id} [put]
This endpoint allows for updating an existing manual balance.
Path parameters accepted: id.
- id: Balance ID
Query parameters accepted: walletId.
- walletId: Wallet ID
Body parameters accepted: request.
- request: Balance update body

Response Example:

{
  "amount": "string",
  "amountBtc": "string",
  "apl": "string",
  "aplPercentage": "string",
  "asset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "available": "string",
  "avgCost": "string",
  "balanceType": "string",
  "closeOrdersCount": 0,
  "exchangeId": 0,
  "extraCoinsNeededCount": "string",
  "extraCoinsNeededProfit": "string",
  "id": 0,
  "isManual": true,
  "openOrdersCount": 0,
  "total": "string",
  "totalCost": "string",
  "volume24H": "string",
  "volumeBtc24H": "string",
  "wallet": {
    "exchange": {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    },
    "id": 0,
    "name": "string"
  }
}

DeleteManualBalance

Url: https://api.test.raydar.app/swagger/index.html#/manual-balances/DeleteManualBalance
The endpoint used is /v1/manual-balances/{id} [delete]
This endpoint allows for deleting an existing manual balance.
Query parameters accepted: walletId.
- walletId: Wallet ID
Path parameters accepted: id.
- id: Balance ID

Response Example:

"string"

manual-transactions

CreateTransaction

Url: https://api.test.raydar.app/swagger/index.html#/manual-transactions/CreateTransaction
The endpoint used is /v1/manual-transactions [post]
Creates a new manual transaction with the provided details
Query parameters accepted: walletId.
- walletId: Wallet ID
Body parameters accepted: request.
- request: Transaction creation request

Response Example:

{
  "address": "string",
  "commission": "string",
  "commissionCurrencyID": 0,
  "currencyID": 0,
  "fiatAmount": "string",
  "id": 0,
  "isBuyer": true,
  "isMaker": true,
  "isManual": true,
  "orderId": "string",
  "price": "string",
  "quantity": "string",
  "status": "string",
  "symbolID": 0,
  "time": 0,
  "totalPrice": "string",
  "tradeId": "string",
  "transactionId": "string",
  "type": "string",
  "walletId": 0
}

GetTransaction

Url: https://api.test.raydar.app/swagger/index.html#/manual-transactions/GetTransaction
The endpoint used is /v1/manual-transactions/{id} [get]
This endpoint allows retrieving a single transaction by ID and type
Path parameters accepted: id.
- id: Transaction ID
Query parameters accepted: walletId, and type.
- walletId: Wallet ID
- type: Transaction Type enums(DEPOSIT, WITHDRAW, FIATBUY, FIATSELL, TRADE)

Response Example:

{
  "address": "string",
  "baseAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "baseAssetAmount": "string",
  "commission": "string",
  "commissionAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "id": 0,
  "isBuyer": true,
  "targetAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "targetAssetAmount": "string",
  "time": 0
}

UpdateTransaction

Url: https://api.test.raydar.app/swagger/index.html#/manual-transactions/UpdateTransaction
The endpoint used is /v1/manual-transactions/{id} [put]
Updates an existing manual transaction with the provided details
Path parameters accepted: id.
- id: Transaction ID
Query parameters accepted: walletId, and type.
- walletId: Wallet ID
- type: Transaction Type enums(DEPOSIT, WITHDRAW, FIATBUY, FIATSELL, TRADE)
Body parameters accepted: request.
- request: Transaction update request

Response Example:

{
  "address": "string",
  "commission": "string",
  "commissionCurrencyID": 0,
  "currencyID": 0,
  "fiatAmount": "string",
  "id": 0,
  "isBuyer": true,
  "isMaker": true,
  "isManual": true,
  "orderId": "string",
  "price": "string",
  "quantity": "string",
  "status": "string",
  "symbolID": 0,
  "time": 0,
  "totalPrice": "string",
  "tradeId": "string",
  "transactionId": "string",
  "type": "string",
  "walletId": 0
}

DeleteTransaction

Url: https://api.test.raydar.app/swagger/index.html#/manual-transactions/DeleteTransaction
The endpoint used is /v1/manual-transactions/{id} [delete]
Deletes an existing manual transaction
Path parameters accepted: id.
- id: Transaction ID
Query parameters accepted: walletId, and type.
- walletId: Wallet ID
- type: Transaction Type enums(DEPOSIT, WITHDRAW, FIATBUY, FIATSELL, TRADE)

Response Example:

"string"

marketMetrics

GetAltCoinSeasonIndex

Url: https://api.test.raydar.app/swagger/index.html#/marketMetrics/GetAltCoinSeasonIndex
The endpoint used is /v1/markets/metrics/altcoin/season [get]
Retrieves the latest Altcoin Season Index data from cache. If the data is not found in cache, it returns a 404 error. The Altcoin Season Index helps indicate whether the market favors altcoins over Bitcoin.

Response Example:

{
  "altcoinIndex": "string",
  "timestamp": "string"
}

GetAssetDetails

Url: https://api.test.raydar.app/swagger/index.html#/marketMetrics/GetAssetDetails
The endpoint used is /v1/markets/metrics/asset/{code}/details [get]
Retrieves detailed market information for a cryptocurrency asset by its symbol code. Data is fetched from cache if available. If not found, triggers a cache refresh task. Includes price, market cap, supply information, and historical price data.
Path parameters accepted: code.
- code: Asset Code

Response Example:

{
  "allTimeHigh": "string",
  "allTimeLow": "string",
  "circulatingSupply": "string",
  "dominance": "string",
  "dominanceChangePct": "string",
  "highAllTimeTimestamp": "string",
  "lowAllTimeTimestamp": "string",
  "marketCap": "string",
  "maxSupply": "string",
  "name": "string",
  "percentChange24h": "string",
  "price": "string",
  "rank": "string",
  "rating": 0,
  "slug": "string",
  "totalSupply": "string",
  "urls": {
    "announcement": [
      "string"
    ],
    "chat": [
      "string"
    ],
    "explorer": [
      "string"
    ],
    "facebook": [
      "string"
    ],
    "messageBoard": [
      "string"
    ],
    "reddit": [
      "string"
    ],
    "sourceCode": [
      "string"
    ],
    "technicalDoc": [
      "string"
    ],
    "twitter": [
      "string"
    ],
    "website": [
      "string"
    ]
  },
  "volume24h": "string"
}

GetBitcoinMVRVZScore

Url: https://api.test.raydar.app/swagger/index.html#/marketMetrics/GetBitcoinMVRVZScore
The endpoint used is /v1/markets/metrics/bitcoin-mvrv-z-score [get]
Fetches bitcoin mvrv-z score metrics. Data is retrieved from the cache using a compound key.

Response Example:

[
  {
    "date": "string",
    "marketCap": "string",
    "mvrvZscore": "string",
    "realizedCap": "string",
    "timestamp": "string"
  }
]

GetCoinLaunches

Url: https://api.test.raydar.app/swagger/index.html#/marketMetrics/GetCoinLaunches
The endpoint used is /v1/markets/metrics/coin-launches [get]
Fetches coin launches metrics. Data is retrieved from the cache using a compound key.

Response Example:

[
  {
    "category": "string",
    "coinLink": "string",
    "date": "string",
    "initialCap": "string",
    "key": "string",
    "name": "string",
    "presaleType": "string",
    "raise": "string",
    "salePrice": "string",
    "symbol": "string",
    "totalRaise": "string"
  }
]

GetLongShortRatio

Url: https://api.test.raydar.app/swagger/index.html#/marketMetrics/GetLongShortRatio
The endpoint used is /v1/markets/metrics/{exchange}/{code}/long-short-ratio [get]
Fetches long/short ratio metrics for a given asset code and exchange. Data is retrieved from the cache using a compound key (exchange + code). Returns 404 if data is not found in cache.
Path parameters accepted: code, and exchange.
- code: Asset Code (e.g. BTC)
- exchange: Exchange Name Enums(binance,okx,gateio,kraken,bitfinex,bitget,bitget,mexc,bybit,htx,all) enums(binance, okx, gateio, kraken, bitfinex, bitget, bitget, mexc, bybit, htx, all)

Response Example:

{
  "longAccount": 0,
  "longShortRatio": 0,
  "longVolume": 0,
  "shortAccount": 0,
  "shortVolume": 0,
  "symbol": "string"
}

GetOpenInterest

Url: https://api.test.raydar.app/swagger/index.html#/marketMetrics/GetOpenInterest
The endpoint used is /v1/markets/metrics/{exchange}/{code}/open-interest [get]
Fetches open interest metrics for a given asset code and exchange. Data is retrieved from the cache using a compound key (exchange + code). Returns 404 if data is not found in cache.
Path parameters accepted: code, and exchange.
- code: Asset Code (e.g. BTCUSDT)
- exchange: Exchange Name Enums(binance,bingx,gateio,bybit,bitget,kraken,htx,kucoin,coinbase,okx,bitstamp,cryptocom,bitfinex,mexc,whitebit,coinw,probit,bitmart,gemini,all) enums(binance, bingx, gateio, bybit, bitget, kraken, htx, kucoin, coinbase, okx, bitstamp, cryptocom, bitfinex, mexc, whitebit, coinw, probit, bitmart, gemini, all)

Response Example:

{
  "fundingRate": 0,
  "openInterestUsd": 0
}

memberships

Memberships

Url: https://api.test.raydar.app/swagger/index.html#/memberships/Memberships
The endpoint used is /v1/memberships [get]
This endpoint retrieves a list of active memberships, categorized by their period (monthly, yearly, etc.).

Response Example:

{
  "monthly": [
    {
      "attributes": {},
      "basePrice": "string",
      "description": {},
      "id": 0,
      "isActive": true,
      "name": "string",
      "period": 0,
      "price": "string",
      "type": "string"
    }
  ],
  "yearly": [
    {
      "attributes": {},
      "basePrice": "string",
      "description": {},
      "id": 0,
      "isActive": true,
      "name": "string",
      "period": 0,
      "price": "string",
      "type": "string"
    }
  ]
}

news

GetNews

Url: https://api.test.raydar.app/swagger/index.html#/news/GetNews
The endpoint used is /v1/news [get]
Fetches and returns cached or fresh crypto-related news articles for today.
Query parameters accepted: lang.
- lang: Language of the news (e.g., en, tr) default(en)

Response Example:

{
  "articles": [
    {
      "author": "string",
      "content": "string",
      "description": "string",
      "publishedAt": "string",
      "source": {
        "id": null,
        "name": "string"
      },
      "title": "string",
      "url": "string",
      "urlToImage": "string"
    }
  ],
  "status": "string",
  "totalResults": 0
}

orders

GetOrders

Url: https://api.test.raydar.app/swagger/index.html#/orders/GetOrders
The endpoint used is /v1/orders [get]
This endpoint allows retrieving a list of orders with various filters and pagination.
Query parameters accepted: offset, limit, walletId, coin, symbolId, exchangeId, startDate, endDate, sort, side, type, and status.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- walletId: Wallet ID
- coin: Coin Code
- symbolId: Symbol ID
- exchangeId: Exchange ID
- startDate: Start Date
- endDate: End Date
- sort: Sort by field enums(price, price-, quantity, quantity-, time, time-, exchangeName, exchangeName-)
- side: Buy or Sell enums(BUY, SELL)
- type: Order Type enums(SPOT, MARGIN, FUTURE, EARN)
- status: OPEN or CLOSED enums(OPEN, CLOSED, CANCELED)

Response Example:

{
  "itemCount": 0,
  "orders": [
    {
      "baseAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "currentPrice": "string",
      "exchange": {
        "baseUrl": "string",
        "credentialInfo": {},
        "exchangeBaseAsset": "string",
        "exchangeIcon": "string",
        "exchangeLogo": "string",
        "id": 0,
        "info": {},
        "mobileIcon": "string",
        "mobileLogo": "string",
        "name": "string"
      },
      "executedQTY": "string",
      "id": 0,
      "isFromApp": true,
      "isManual": true,
      "isWhaleproof": true,
      "leverage": 0,
      "orderId": "string",
      "orderType": "string",
      "potentialProfitPercent": "string",
      "potentialProfitUsdt": "string",
      "price": "string",
      "quantity": "string",
      "remainQuantity": "string",
      "side": "string",
      "status": "string",
      "targetAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "targetPrice": "string",
      "time": 0,
      "totalAmount": "string",
      "totalCommission": "string",
      "totalCommissionBtc": "string",
      "type": "string",
      "walletId": 0,
      "walletName": "string"
    }
  ]
}

CreateOrder

Url: https://api.test.raydar.app/swagger/index.html#/orders/CreateOrder
The endpoint used is /v1/orders [post]
This endpoint creates a new order on the exchange.
Body parameters accepted: request.
- request: Create Order Request

Response Example:

{
  "baseAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "currentPrice": "string",
  "exchange": {
    "baseUrl": "string",
    "credentialInfo": {},
    "exchangeBaseAsset": "string",
    "exchangeIcon": "string",
    "exchangeLogo": "string",
    "id": 0,
    "info": {},
    "mobileIcon": "string",
    "mobileLogo": "string",
    "name": "string"
  },
  "executedQTY": "string",
  "id": 0,
  "isFromApp": true,
  "isManual": true,
  "isWhaleproof": true,
  "leverage": 0,
  "orderId": "string",
  "orderType": "string",
  "potentialProfitPercent": "string",
  "potentialProfitUsdt": "string",
  "price": "string",
  "quantity": "string",
  "remainQuantity": "string",
  "side": "string",
  "status": "string",
  "targetAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "targetPrice": "string",
  "time": 0,
  "totalAmount": "string",
  "totalCommission": "string",
  "totalCommissionBtc": "string",
  "type": "string",
  "walletId": 0,
  "walletName": "string"
}

GetOrdersSummary

Url: https://api.test.raydar.app/swagger/index.html#/orders/GetOrdersSummary
The endpoint used is /v1/orders/summary [get]
This endpoint allows for getting orders summary, including total volume, commission, and other related information.

Response Example:

{
  "coinUrls": [
    "string"
  ],
  "currentVolume": "string",
  "exchangeUrls": [
    "string"
  ],
  "totalBuyVolume": "string",
  "totalBuyVolumeBtc": "string",
  "totalCommission": "string",
  "totalCommissionBtc": "string",
  "totalSellVolume": "string",
  "totalSellVolumeBtc": "string",
  "totalVolume": "string",
  "totalVolumeBtc": "string"
}

CancelOrder

Url: https://api.test.raydar.app/swagger/index.html#/orders/CancelOrder
The endpoint used is /v1/orders/{orderId}/cancel [post]
This endpoint cancels an order on the exchange.
Query parameters accepted: walletId.
- walletId: Wallet ID
Path parameters accepted: orderId.
- orderId: Order ID

positions

GetPositions

Url: https://api.test.raydar.app/swagger/index.html#/positions/GetPositions
The endpoint used is /v1/positions [get]
This endpoint allows retrieving a list of positions with various filters and pagination.
Query parameters accepted: offset, limit, walletId, and exchangeId.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- walletId: Wallet ID
- exchangeId: Exchange ID

Response Example:

{
  "itemCount": 0,
  "positions": [
    {
      "avgPrice": "string",
      "exchange": {
        "baseUrl": "string",
        "credentialInfo": {},
        "exchangeBaseAsset": "string",
        "exchangeIcon": "string",
        "exchangeLogo": "string",
        "id": 0,
        "info": {},
        "mobileIcon": "string",
        "mobileLogo": "string",
        "name": "string"
      },
      "fee": "string",
      "leverage": "string",
      "leveragedQuantity": "string",
      "liquidationPrice": "string",
      "positionSide": "string",
      "realizedProfit": "string",
      "symbol": "string",
      "time": 0,
      "unLeveragedQuantity": "string",
      "unrealizedProfit": "string",
      "walletName": "string"
    }
  ]
}

regions

GetRegions

Url: https://api.test.raydar.app/swagger/index.html#/regions/GetRegions
The endpoint used is /v1/regions [get]
This endpoint retrieves all available regions for exchanges.

Response Example:

{
  "regions": [
    {
      "code": "string",
      "icon": "string",
      "id": 0,
      "locale": "string",
      "name": "string",
      "title": "string"
    }
  ]
}

reports

ReportsCoinDistribution

Url: https://api.test.raydar.app/swagger/index.html#/reports/ReportsCoinDistribution
The endpoint used is /v1/reports/coins/distribution [get]
Returns a pie-ready list of coins and their amounts in user’s currency

Response Example:

{
  "items": [
    {
      "icon": "string",
      "percentage": "string",
      "quantity": "string",
      "symbol": "string",
      "value": "string"
    }
  ]
}

ReportsExchangeDistribution

Url: https://api.test.raydar.app/swagger/index.html#/reports/ReportsExchangeDistribution
The endpoint used is /v1/reports/exchanges/distribution [get]
Returns a pie-ready list of exchanges and their amounts in user’s currency

Response Example:

{
  "items": [
    {
      "assetCount": 0,
      "icon": "string",
      "name": "string",
      "percentage": "string",
      "value": "string"
    }
  ]
}

ReportsPortfolioHealth

Url: https://api.test.raydar.app/swagger/index.html#/reports/ReportsPortfolioHealth
The endpoint used is /v1/reports/portfolio/health [get]
Calculates portfolio risk and health score using internal risk model
Query parameters accepted: exchangeId, and walletId.
- exchangeId: Exchange ID
- walletId: Wallet ID

Response Example:

{
  "assetRisks": [
    {
      "apl": "1500.25",
      "aplPercentage": "6.38",
      "asset": "BTC",
      "category": "low",
      "cmcRank": "1",
      "icon": "https://cdn.raydar.app/icons/BTC.png",
      "riskScore": "40",
      "value": "25000.50",
      "weight": "0.35"
    }
  ],
  "health": "65.5",
  "riskLevel": "medium"
}

ReportsPortfolioHistory

Url: https://api.test.raydar.app/swagger/index.html#/reports/ReportsPortfolioHistory
The endpoint used is /v1/reports/portfolio/history [get]
Get portfolio history (daily USDT totals)
Query parameters accepted: offset, limit, from, and to.
- offset: Page offset default(0)
- limit: Page limit default(30)
- from: From date (ms). Default: now-1y
- to: To date (ms). Default: now

Response Example:

{
  "itemCount": 0,
  "items": [
    {
      "date": "string",
      "total": "string"
    }
  ]
}

ReportsTradeActivity

Url: https://api.test.raydar.app/swagger/index.html#/reports/ReportsTradeActivity
The endpoint used is /v1/reports/trades/activity [get]
Returns count and volume aggregated by day/week/month/year
Query parameters accepted: startTime, endTime, and interval.
- startTime: Start time (ms). Default: now-7d
- endTime: End time (ms). Default: now
- interval: Interval default(day) enums(day, week, month, year)

Response Example:

{
  "from": 0,
  "interval": "string",
  "items": [
    {
      "count": 0,
      "period": "string",
      "volume": "string"
    }
  ],
  "to": 0
}

stripe

StripeCallback

Url: https://api.test.raydar.app/swagger/index.html#/stripe/StripeCallback
The endpoint used is /v1/stripe/callback [post]
This endpoint allows for handling the callback response from Stripe after a payment is processed.
Body parameters accepted: request.
- request: Stripe callback body containing payment response data

Response Example:

"string"

Checkout

Url: https://api.test.raydar.app/swagger/index.html#/stripe/Checkout
The endpoint used is /v1/stripe/checkout [get]
This endpoint redirects the user to the Stripe checkout page for payment processing.
Query parameters accepted: membershipId.
- membershipId: Membership ID for the plan to be purchased

Response Example:

{
  "checkout_url": "string"
}

symbols

GetSymbols

Url: https://api.test.raydar.app/swagger/index.html#/symbols/GetSymbols
The endpoint used is /v1/symbols [get]
This endpoint retrieves a list of trading symbols, with optional filtering by coin ID, search query, and sorting.
Query parameters accepted: offset, limit, coinId, search, and sort.
- offset: Page offset default(0)
- limit: Page limit default(10)
- coinId: Filter by Coin ID
- search: Search for asset by name
- sort: Sort by field enums(name, name-)

Response Example:

{
  "itemCount": 0,
  "symbols": [
    {
      "baseAsset": 0,
      "id": 0,
      "name": "string",
      "targetAsset": 0
    }
  ]
}

GetPopularSymbol

Url: https://api.test.raydar.app/swagger/index.html#/symbols/GetPopularSymbol
The endpoint used is /v1/symbols/popular [get]
Retrieves a list of popular trading symbols with their price, volume, change and change percent.
Query parameters accepted: offset, and limit.
- offset: Page offset default(0)
- limit: Page limit default(10)

Response Example:

{
  "itemCount": 0,
  "symbols": [
    {
      "change": "string",
      "changePercent": "string",
      "code": "string",
      "icon": "string",
      "id": 0,
      "name": "string",
      "price": "string",
      "symbol": "string",
      "volume": "string"
    }
  ]
}

GetSymbolDataByMarketType

Url: https://api.test.raydar.app/swagger/index.html#/symbols/GetSymbolDataByMarketType
The endpoint used is /v1/symbols/trading/{exchange}/{marketType} [get]
Returns the list of trading symbol names available for a given exchange and market type, sourced from cache.
Query parameters accepted: offset, limit, code, and search.
- offset: Page offset default(0)
- limit: Page limit default(10)
- code: Asset Code
- search: Search for base or target asset by name
Path parameters accepted: exchange, and marketType.
- exchange: Exchange name (lowercase) default(binance) enums(binance, binance-tr, bingx, bitexen, bitfinex, bitget, bitmart, bitstamp, btcturk, bybit, coin-tr, coinbase, coinbase-futures, coinw, cryptocom, gate-tr, gateio, gemini, gemini-futures, htx, icrypex, kraken, kraken-futures, kucoin, mexc, okx, okx-tr, probit, whitebit)
- marketType: Market type enums(spot, margin, iMargin, uFutures, cFutures)

Response Example:

{
  "itemCount": 0,
  "symbols": [
    {
      "baseAsset": "string",
      "id": 0,
      "rawBaseAsset": "string",
      "rawSymbol": "string",
      "rawTargetAsset": "string",
      "targetAsset": "string"
    }
  ]
}

GetSymbolData

Url: https://api.test.raydar.app/swagger/index.html#/symbols/GetSymbolData
The endpoint used is /v1/symbols/{code}/{exchange}/{type} [get]
Retrieves cached symbol data (price, change, or changePercent) by code, exchange, and data type.
Path parameters accepted: code, exchange, and type.
- code: Symbol Code default(BTCUSDT)
- exchange: Exchange Name default(binance)
- type: Data Type default(price) enums(price, change, changePercent)

Response Example:

{
  "value": "string"
}

GetSymbolDataByCode

Url: https://api.test.raydar.app/swagger/index.html#/symbols/GetSymbolDataByCode
The endpoint used is /v1/symbols/{code}/{type} [get]
Retrieves cached symbol data (price, change, or changePercent) by code and data type.
Path parameters accepted: code, and type.
- code: Symbol Code default(BTCUSDT)
- type: Data Type default(price) enums(price, change, changePercent)

Response Example:

{
  "value": "string"
}

GetSymbol

Url: https://api.test.raydar.app/swagger/index.html#/symbols/GetSymbol
The endpoint used is /v1/symbols/{id} [get]
This endpoint retrieves a specific symbol by its ID.
Path parameters accepted: id.
- id: Symbol ID

Response Example:

{
  "baseAsset": 0,
  "id": 0,
  "name": "string",
  "targetAsset": 0
}

GetSymbolExchanges

Url: https://api.test.raydar.app/swagger/index.html#/symbols/GetSymbolExchanges
The endpoint used is /v1/symbols/{id}/exchanges [get]
This endpoint retrieves exchanges of a specific symbol by its ID.
Path parameters accepted: id.
- id: Symbol ID

Response Example:

{
  "exchanges": [
    {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    }
  ],
  "itemCount": 0
}

taxes

CalculateTax

Url: https://api.test.raydar.app/swagger/index.html#/taxes/CalculateTax
The endpoint used is /v1/tax/calculate [post]
This endpoint calculates tax based on provided trade details in the request body.
Body parameters accepted: request.
- request: Tax Calculation Details

Response Example:

{
  "profit": "string",
  "taxAmount": "string",
  "taxRate": "string"
}

GetTaxReports

Url: https://api.test.raydar.app/swagger/index.html#/taxes/GetTaxReports
The endpoint used is /v1/tax/reports [get]
This endpoint allows retrieving a list of taxes based on various filter parameters, such as wallet ID, coin ID, date range, and transaction type.
Query parameters accepted: startDate, endDate, walletId, and exchangeId.
- startDate: Start Date
- endDate: End Date
- walletId: Wallet ID
- exchangeId: Exchange ID

Response Example:

{
  "lossReports": [
    {
      "baseAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "exchangeIcon": "string",
      "exchangeName": "string",
      "gainLossAmount": "string",
      "sellDate": "string",
      "targetAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "taxAmount": "string"
    }
  ],
  "profitReports": [
    {
      "baseAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "exchangeIcon": "string",
      "exchangeName": "string",
      "gainLossAmount": "string",
      "sellDate": "string",
      "targetAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "taxAmount": "string"
    }
  ],
  "totalGain": "string",
  "totalGainLoss": "string",
  "totalLoss": "string",
  "totalTaxAmount": "string"
}

trades

GetTrades

Url: https://api.test.raydar.app/swagger/index.html#/trades/GetTrades
The endpoint used is /v1/trades [get]
This endpoint allows retrieving a list of trades based on various filter parameters, such as wallet ID, coin ID, date range, and transaction type.
Query parameters accepted: offset, limit, walletId, coin, tradeType, exchangeId, startDate, endDate, sort, isBuyer, type, and orderId.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- walletId: Wallet ID
- coin: Coin Code
- tradeType: Trade Type enums(FUTURE, MARGIN, SPOT)
- exchangeId: Exchange ID
- startDate: Start Date
- endDate: End Date
- sort: Sort by field default(time-) enums(price, price-, quantity, quantity-, totalPrice, totalPrice-, commission, commission-, time, time-, exchangeName, exchangeName-)
- isBuyer: Buy or Sell enums(True, False)
- type: Transaction Type enums(DEPOSIT, WITHDRAW, FIATBUY, FIATSELL, TRANSFERIN, TRANSFEROUT, CONVERT, TRADE, EARNREWARD)
- orderId: Order ID

Response Example:

{
  "itemCount": 0,
  "transactions": [
    {
      "baseAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "baseAssetCurrentPrice": "string",
      "commission": "string",
      "commissionCurrency": "string",
      "commissionFiat": "string",
      "id": 0,
      "isBuyer": true,
      "isMaker": true,
      "isManual": true,
      "orderId": "string",
      "price": "string",
      "quantity": "string",
      "targetAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "targetAssetCurrentPrice": "string",
      "targetQuantity": "string",
      "time": 0,
      "totalBtc": "string",
      "totalCurrentPrice": "string",
      "totalPrice": "string",
      "tradeType": "string",
      "type": "string",
      "wallet": {
        "exchange": {
          "baseUrl": "string",
          "credentialInfo": {},
          "exchangeBaseAsset": "string",
          "exchangeIcon": "string",
          "exchangeLogo": "string",
          "id": 0,
          "info": {},
          "mobileIcon": "string",
          "mobileLogo": "string",
          "name": "string"
        },
        "id": 0,
        "name": "string"
      }
    }
  ]
}

GetTradesSummary

Url: https://api.test.raydar.app/swagger/index.html#/trades/GetTradesSummary
The endpoint used is /v1/trades/summary [get]
This endpoint retrieves a summary of trades based on various filters such as wallet, coin, exchange, date range, and transaction type.
Query parameters accepted: walletId, coin, exchangeId, startDate, endDate, tradeType, sort, isBuyer, type, and orderId.
- walletId: Wallet ID
- coin: Coin Code
- exchangeId: Exchange ID
- startDate: Start Date in Unix timestamp (milliseconds)
- endDate: End Date in Unix timestamp (milliseconds)
- tradeType: Trade Type enums(FUTURE, MARGIN, SPOT)
- sort: Sort by field default(time-) enums(price, price-, quantity, quantity-, totalPrice, totalPrice-, commission, commission-, time, time-)
- isBuyer: Buy or Sell enums(True, False)
- type: Buy or Sell enums(FIATBUY, TRANSFERIN, TRANSFEROUT, TRADE)
- orderId: Filter by Order ID

Response Example:

{
  "coinCount": 0,
  "coinUrls": [
    "string"
  ],
  "exchangeCount": 0,
  "exchangeUrls": [
    "string"
  ],
  "totalCommission": "string",
  "totalCommissionBtc": "string",
  "totalInboundVolume": "string",
  "totalInboundVolumeBtc": "string",
  "totalOutboundVolume": "string",
  "totalOutboundVolumeBtc": "string",
  "totalVolume": "string",
  "totalVolumeBtc": "string"
}

GetTrade

Url: https://api.test.raydar.app/swagger/index.html#/trades/GetTrade
The endpoint used is /v1/trades/{id} [get]
Retrieve details of a specific trade by ID for the authenticated user’s wallet
Path parameters accepted: id.
- id: Trade ID
Query parameters accepted: walletId.
- walletId: Wallet ID

Response Example:

{
  "baseAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "baseAssetCurrentPrice": "string",
  "commission": "string",
  "commissionCurrency": "string",
  "commissionFiat": "string",
  "id": 0,
  "isBuyer": true,
  "isMaker": true,
  "isManual": true,
  "orderId": "string",
  "price": "string",
  "quantity": "string",
  "targetAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "targetAssetCurrentPrice": "string",
  "targetQuantity": "string",
  "time": 0,
  "totalBtc": "string",
  "totalCurrentPrice": "string",
  "totalPrice": "string",
  "tradeType": "string",
  "type": "string",
  "wallet": {
    "exchange": {
      "baseUrl": "string",
      "credentialInfo": {},
      "exchangeBaseAsset": "string",
      "exchangeIcon": "string",
      "exchangeLogo": "string",
      "id": 0,
      "info": {},
      "mobileIcon": "string",
      "mobileLogo": "string",
      "name": "string"
    },
    "id": 0,
    "name": "string"
  }
}

wallets

GetWallets

Url: https://api.test.raydar.app/swagger/index.html#/wallets/GetWallets
The endpoint used is /v1/wallets [get]
This endpoint allows for retrieving a list of wallets with pagination, filtering, and sorting options.
Query parameters accepted: offset, limit, exchangeId, coin, and sort.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- exchangeId: Exchange ID
- coin: Coin Code
- sort: Sort By enums(amount, amount-, coinCount, coinCount-, id, id-, syncDate, syncDate-, name, name-, exchangeName, exchangeName-)

Response Example:

{
  "itemCount": 0,
  "totalBalance": "string",
  "totalBtc": "string",
  "totalCommission": "string",
  "totalCommissionBtc": "string",
  "totalDeposit": "string",
  "totalDepositBtc": "string",
  "totalWithdraw": "string",
  "totalWithdrawBtc": "string",
  "wallets": [
    {
      "apl": "string",
      "coinCount": 0,
      "coinIcons": [
        "string"
      ],
      "commission": "string",
      "commissionBtc": "string",
      "currencyId": 0,
      "deposit": "string",
      "depositBtc": "string",
      "earnBalance": "string",
      "earnBtc": "string",
      "exchange": {
        "baseUrl": "string",
        "credentialInfo": {},
        "exchangeBaseAsset": "string",
        "exchangeIcon": "string",
        "exchangeLogo": "string",
        "id": 0,
        "info": {},
        "mobileIcon": "string",
        "mobileLogo": "string",
        "name": "string"
      },
      "futuresBalance": "string",
      "futuresBtc": "string",
      "id": 0,
      "isActive": true,
      "isFuture": true,
      "isManual": true,
      "isMargin": true,
      "isSync": true,
      "marginBalance": "string",
      "marginBtc": "string",
      "name": "string",
      "spotBalance": "string",
      "spotBtc": "string",
      "syncDate": 0,
      "totalBalance": "string",
      "totalBtc": "string",
      "totalCost": "string",
      "withdrawBtc": "string",
      "withdrawal": "string"
    }
  ]
}

CreateWallet

Url: https://api.test.raydar.app/swagger/index.html#/wallets/CreateWallet
The endpoint used is /v1/wallets [post]
This endpoint allows for creating a new wallet for a user.
Body parameters accepted: request.
- request: Wallet create body

Response Example:

{
  "apl": "string",
  "coinCount": 0,
  "coinIcons": [
    "string"
  ],
  "commission": "string",
  "commissionBtc": "string",
  "currencyId": 0,
  "deposit": "string",
  "depositBtc": "string",
  "earnBalance": "string",
  "earnBtc": "string",
  "exchange": {
    "baseUrl": "string",
    "credentialInfo": {},
    "exchangeBaseAsset": "string",
    "exchangeIcon": "string",
    "exchangeLogo": "string",
    "id": 0,
    "info": {},
    "mobileIcon": "string",
    "mobileLogo": "string",
    "name": "string"
  },
  "futuresBalance": "string",
  "futuresBtc": "string",
  "id": 0,
  "isActive": true,
  "isFuture": true,
  "isManual": true,
  "isMargin": true,
  "isSync": true,
  "marginBalance": "string",
  "marginBtc": "string",
  "name": "string",
  "spotBalance": "string",
  "spotBtc": "string",
  "syncDate": 0,
  "totalBalance": "string",
  "totalBtc": "string",
  "totalCost": "string",
  "withdrawBtc": "string",
  "withdrawal": "string"
}

CreateManualWallet

Url: https://api.test.raydar.app/swagger/index.html#/wallets/CreateManualWallet
The endpoint used is /v1/wallets/manual [post]
This endpoint allows for creating a new manual wallet without exchange integration.
Body parameters accepted: request.
- request: Manual wallet create body

Response Example:

{
  "apl": "string",
  "coinCount": 0,
  "coinIcons": [
    "string"
  ],
  "commission": "string",
  "commissionBtc": "string",
  "currencyId": 0,
  "deposit": "string",
  "depositBtc": "string",
  "earnBalance": "string",
  "earnBtc": "string",
  "exchange": {
    "baseUrl": "string",
    "credentialInfo": {},
    "exchangeBaseAsset": "string",
    "exchangeIcon": "string",
    "exchangeLogo": "string",
    "id": 0,
    "info": {},
    "mobileIcon": "string",
    "mobileLogo": "string",
    "name": "string"
  },
  "futuresBalance": "string",
  "futuresBtc": "string",
  "id": 0,
  "isActive": true,
  "isFuture": true,
  "isManual": true,
  "isMargin": true,
  "isSync": true,
  "marginBalance": "string",
  "marginBtc": "string",
  "name": "string",
  "spotBalance": "string",
  "spotBtc": "string",
  "syncDate": 0,
  "totalBalance": "string",
  "totalBtc": "string",
  "totalCost": "string",
  "withdrawBtc": "string",
  "withdrawal": "string"
}

GetWallet

Url: https://api.test.raydar.app/swagger/index.html#/wallets/GetWallet
The endpoint used is /v1/wallets/{id} [get]
This endpoint allows for retrieving details of a specific wallet for a user.
Path parameters accepted: id.
- id: Wallet ID

Response Example:

{
  "apl": "string",
  "coinCount": 0,
  "coinIcons": [
    "string"
  ],
  "commission": "string",
  "commissionBtc": "string",
  "currencyId": 0,
  "deposit": "string",
  "depositBtc": "string",
  "earnBalance": "string",
  "earnBtc": "string",
  "exchange": {
    "baseUrl": "string",
    "credentialInfo": {},
    "exchangeBaseAsset": "string",
    "exchangeIcon": "string",
    "exchangeLogo": "string",
    "id": 0,
    "info": {},
    "mobileIcon": "string",
    "mobileLogo": "string",
    "name": "string"
  },
  "futuresBalance": "string",
  "futuresBtc": "string",
  "id": 0,
  "isActive": true,
  "isFuture": true,
  "isManual": true,
  "isMargin": true,
  "isSync": true,
  "marginBalance": "string",
  "marginBtc": "string",
  "name": "string",
  "spotBalance": "string",
  "spotBtc": "string",
  "syncDate": 0,
  "totalBalance": "string",
  "totalBtc": "string",
  "totalCost": "string",
  "withdrawBtc": "string",
  "withdrawal": "string"
}

UpdateWallet

Url: https://api.test.raydar.app/swagger/index.html#/wallets/UpdateWallet
The endpoint used is /v1/wallets/{id} [put]
This endpoint allows for updating an existing wallet for a user.
Path parameters accepted: id.
- id: Wallet ID
Body parameters accepted: request.
- request: Updated wallet information

Response Example:

{
  "apl": "string",
  "coinCount": 0,
  "coinIcons": [
    "string"
  ],
  "commission": "string",
  "commissionBtc": "string",
  "currencyId": 0,
  "deposit": "string",
  "depositBtc": "string",
  "earnBalance": "string",
  "earnBtc": "string",
  "exchange": {
    "baseUrl": "string",
    "credentialInfo": {},
    "exchangeBaseAsset": "string",
    "exchangeIcon": "string",
    "exchangeLogo": "string",
    "id": 0,
    "info": {},
    "mobileIcon": "string",
    "mobileLogo": "string",
    "name": "string"
  },
  "futuresBalance": "string",
  "futuresBtc": "string",
  "id": 0,
  "isActive": true,
  "isFuture": true,
  "isManual": true,
  "isMargin": true,
  "isSync": true,
  "marginBalance": "string",
  "marginBtc": "string",
  "name": "string",
  "spotBalance": "string",
  "spotBtc": "string",
  "syncDate": 0,
  "totalBalance": "string",
  "totalBtc": "string",
  "totalCost": "string",
  "withdrawBtc": "string",
  "withdrawal": "string"
}

DeleteWallet

Url: https://api.test.raydar.app/swagger/index.html#/wallets/DeleteWallet
The endpoint used is /v1/wallets/{id} [delete]
This endpoint allows for deleting a wallet by its ID. The user must be the owner of the wallet to perform this action.
Path parameters accepted: id.
- id: Wallet ID

Response Example:

{
  "code": 0,
  "error": "string"
}

WalletBalances

Url: https://api.test.raydar.app/swagger/index.html#/wallets/WalletBalances
The endpoint used is /v1/wallets/{id}/balances/{type} [get]
This endpoint retrieves the balances of a wallet, filtered by balance type and optionally sorted. It also calculates the amount in a specified currency (e.g., USD) or in BTC, if necessary.
Path parameters accepted: id, and type.
- id: Wallet ID
- type: Balance Type enums(SPOT, MARGIN, FUTURE, EARN)
Query parameters accepted: coin, and sort.
- coin: Coin Code
- sort: Sort By enums(total, total-, amount, amount-, apl, apl-, avgCost, avgCost-, totalCost, totalCost-, aplPercentage, aplPercentage-, assetName, assetName-, assetCode, assetCode-)

Response Example:

{
  "balances": [
    {
      "amount": "string",
      "amountBtc": "string",
      "apl": "string",
      "aplPercentage": "string",
      "asset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "available": "string",
      "avgCost": "string",
      "balanceType": "string",
      "closeOrdersCount": 0,
      "exchangeId": 0,
      "extraCoinsNeededCount": "string",
      "extraCoinsNeededProfit": "string",
      "id": 0,
      "isManual": true,
      "openOrdersCount": 0,
      "total": "string",
      "totalCost": "string",
      "volume24H": "string",
      "volumeBtc24H": "string",
      "wallet": {
        "exchange": {
          "baseUrl": "string",
          "credentialInfo": {},
          "exchangeBaseAsset": "string",
          "exchangeIcon": "string",
          "exchangeLogo": "string",
          "id": 0,
          "info": {},
          "mobileIcon": "string",
          "mobileLogo": "string",
          "name": "string"
        },
        "id": 0,
        "name": "string"
      }
    }
  ],
  "itemCount": 0
}

SyncWallet

Url: https://api.test.raydar.app/swagger/index.html#/wallets/SyncWallet
The endpoint used is /v1/wallets/{id}/sync [get]
This endpoint triggers a synchronization of a wallet and returns the task ID for the sync process.
Path parameters accepted: id.
- id: Wallet ID

Response Example:

{
  "code": 0,
  "error": "string"
}

SyncWalletStatus

Url: https://api.test.raydar.app/swagger/index.html#/wallets/SyncWalletStatus
The endpoint used is /v1/wallets/{id}/sync/status [get]
This endpoint retrieves the sync status of a wallet. It checks if the wallet is currently syncing or has already synced.
Path parameters accepted: id.
- id: Wallet ID

Response Example:

{
  "status": "string"
}

whaleproof-orders

GetWhaleproofOrders

Url: https://api.test.raydar.app/swagger/index.html#/whaleproof-orders/GetWhaleproofOrders
The endpoint used is /v1/whaleproof-orders [get]
This endpoint returns a list of the user’s whaleproof orders
Query parameters accepted: offset, limit, and sort.
- offset: Page offset default(0)
- limit: Page Limit default(10)
- sort: Sort default(id desc)

Response Example:

{
  "itemCount": 0,
  "orders": [
    {
      "baseAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "createdAt": 0,
      "exchange": {
        "baseUrl": "string",
        "credentialInfo": {},
        "exchangeBaseAsset": "string",
        "exchangeIcon": "string",
        "exchangeLogo": "string",
        "id": 0,
        "info": {},
        "mobileIcon": "string",
        "mobileLogo": "string",
        "name": "string"
      },
      "expireDate": 0,
      "failureReason": "string",
      "id": 0,
      "orderType": "string",
      "price": "string",
      "quantity": "string",
      "side": "string",
      "status": "string",
      "targetAsset": {
        "code": "string",
        "icon": "string",
        "id": 0,
        "name": "string"
      },
      "triggerPercentage": "string",
      "triggeredAt": 0,
      "updatedAt": 0,
      "walletId": 0,
      "walletName": "string"
    }
  ]
}

CreateWhaleproofOrder

Url: https://api.test.raydar.app/swagger/index.html#/whaleproof-orders/CreateWhaleproofOrder
The endpoint used is /v1/whaleproof-orders [post]
This endpoint allows for creating a whaleproof order that triggers when the price moves by the given percentage
Body parameters accepted: request.
- request: Whaleproof order request

Response Example:

{
  "baseAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "createdAt": 0,
  "exchange": {
    "baseUrl": "string",
    "credentialInfo": {},
    "exchangeBaseAsset": "string",
    "exchangeIcon": "string",
    "exchangeLogo": "string",
    "id": 0,
    "info": {},
    "mobileIcon": "string",
    "mobileLogo": "string",
    "name": "string"
  },
  "expireDate": 0,
  "failureReason": "string",
  "id": 0,
  "orderType": "string",
  "price": "string",
  "quantity": "string",
  "side": "string",
  "status": "string",
  "targetAsset": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string"
  },
  "triggerPercentage": "string",
  "triggeredAt": 0,
  "updatedAt": 0,
  "walletId": 0,
  "walletName": "string"
}

CancelWhaleproofOrder

Url: https://api.test.raydar.app/swagger/index.html#/whaleproof-orders/CancelWhaleproofOrder
The endpoint used is /v1/whaleproof-orders/{id}/cancel [post]
This endpoint allows for cancelling a pending whaleproof order
Path parameters accepted: id.
- id: Whaleproof Order ID

Response Example:

"string"