Raydar API

Raydar API

A robust data infrastructure providing everything you need for crypto.

asset

Get assets

  • Url: http://localhost:8181/swagger/index.html#/assets/GetAssets
  • The endpoint used is /api/v1/assets [get]
  • Query parameters accepted: offset, limit, search, and sort.
    • offset: Defines the starting point for pagination. default(0)
    • limit: Determines the maximum number of assets to be returned. default(10)
    • search: Searches for assets by code. If not specified, all assets are retrieved.
    • sort: Used for sorting assets. code: Ascending order, code-: Descending order.

Response Example:

{
  "assets": [
{
      "id": 1,
      "name": "Bitcoin",
      "code": "BTC",
      "icon": "https://cdn.raydar.app/icons/BTC.png"
    },
  ],
  "itemCount": 10126
}

Get a specific asset by ID

Response Example:

{
  "id": 1,
  "name": "Bitcoin",
  "code": "BTC",
  "icon": "https://cdn.raydar.app/icons/BTC.png"
}

MyAssetFilters Get assets based on filters

Response Example:

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

Login user login

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 Log out the current user

Response Example:

{
  "refreshToken": "string"
}

RefreshToken Refresh user 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 Create a new user

Response Example:

{
  "accountType": "FREE",
  "country": "string",
  "currency": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string",
    "symbol": "string"
  },
  "decimalSymbol": "string",
  "digitGrouping": "string",
  "digitGroupingSymbol": "string",
  "email": "string",
  "firstDayOfTheWeek": "string",
  "firstname": "string",
  "id": 0,
  "lastname": "string",
  "longDateFormat": "string",
  "longTimeFormat": "string",
  "negativeCurrencyFormat": "string",
  "numberOfDigitsAfterDecimal": "string",
  "phone": "string",
  "positiveCurrencyFormat": "string",
  "referenceBy": "string",
  "referenceNo": "string",
  "region": 0,
  "shortDateFormat": "string",
  "shortTimeFormat": "string"
}

GetUser Get a user

Response Example:

{
  "accountType": "FREE",
  "country": "string",
  "currency": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string",
    "symbol": "string"
  },
  "decimalSymbol": "string",
  "digitGrouping": "string",
  "digitGroupingSymbol": "string",
  "email": "string",
  "firstDayOfTheWeek": "string",
  "firstname": "string",
  "id": 0,
  "lastname": "string",
  "longDateFormat": "string",
  "longTimeFormat": "string",
  "negativeCurrencyFormat": "string",
  "numberOfDigitsAfterDecimal": "string",
  "phone": "string",
  "positiveCurrencyFormat": "string",
  "referenceBy": "string",
  "referenceNo": "string",
  "region": 0,
  "shortDateFormat": "string",
  "shortTimeFormat": "string"
}

UpdateUser Update the current user’s details

Response Example:

{
  "accountType": "FREE",
  "country": "string",
  "currency": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string",
    "symbol": "string"
  },
  "decimalSymbol": "string",
  "digitGrouping": "string",
  "digitGroupingSymbol": "string",
  "email": "string",
  "firstDayOfTheWeek": "string",
  "firstname": "string",
  "id": 0,
  "lastname": "string",
  "longDateFormat": "string",
  "longTimeFormat": "string",
  "negativeCurrencyFormat": "string",
  "numberOfDigitsAfterDecimal": "string",
  "phone": "string",
  "positiveCurrencyFormat": "string",
  "referenceBy": "string",
  "referenceNo": "string",
  "region": 0,
  "shortDateFormat": "string",
  "shortTimeFormat": "string"
}

DeleteUser Delete the current user’s account

Response Example:

{
  "accountType": "FREE",
  "country": "string",
  "currency": {
    "code": "string",
    "icon": "string",
    "id": 0,
    "name": "string",
    "symbol": "string"
  },
  "decimalSymbol": "string",
  "digitGrouping": "string",
  "digitGroupingSymbol": "string",
  "email": "string",
  "firstDayOfTheWeek": "string",
  "firstname": "string",
  "id": 0,
  "lastname": "string",
  "longDateFormat": "string",
  "longTimeFormat": "string",
  "negativeCurrencyFormat": "string",
  "numberOfDigitsAfterDecimal": "string",
  "phone": "string",
  "positiveCurrencyFormat": "string",
  "referenceBy": "string",
  "referenceNo": "string",
  "region": 0,
  "shortDateFormat": "string",
  "shortTimeFormat": "string"
}

MyArbitrage Get user arbitrage details

Response Example:

{
  "arbitrage": [
    {
      "coin": {
        "asset": {
          "id": 8147,
          "name": "BTTC",
          "code": "BTTC",
          "icon": "https://cdn.raydar.app/icons/BTTC.png"
        },
        "allExchangesTotal": "30031644"
      },
      "exchanges": [
        {
          "exchange": {
            "id": 2,
            "name": "Binance",
            "exchangeIcon": "https://cdn.raydar.app/icons/binance.svg",
            "exchangeLogo": "https://cdn.raydar.app/icons/binance_logo.svg",
            "baseUrl": "https://www.binance.com/en",
            "credentialInfo": null
          },
          "coinTotal": "30031644"
        }
      ]
    }
  ]
}

AssetsOverview Get assets overview

Response Example:

{
  "totalCoinCount": 42,
  "openOrdersCount": 0,
  "closeOrdersCount": 296,
  "profitableCoinCount": 0,
  "lossCoinCount": 0
}

MyBalances Get the balances of a user

  • Url: http://localhost:8181/swagger/index.html#/users/MyBalances
  • The endpoint used is api/v1/users/me/balances [get]
  • Query parameters offset, limit, walletId, type, coinId, and sort are accepted.
    • offset: Defines the starting point for pagination. default(0)
    • limit: Sets the maximum number of exchanges to return. default(10)
    • walletId: Filters by Wallet ID.
    • type: Filters by balance type.
    • coinId: Filters by Coin ID.
    • sort: Used for sorting. total: Ascending order, total-: Descending order, amount: Ascending order, amount-: Descending order, code: Ascending order, code-: Descending order.

Response Example:

{
  "balances": [
    {
      "id": 49,
      "balanceType": "EARN",
      "total": "30000000",
      "asset": {
        "id": 8147,
        "name": "BTTC",
        "code": "BTTC",
        "icon": "https://cdn.raydar.app/icons/BTTC.png"
      },
      "walletId": 1,
      "exchangeId": 2,
      "amount": "0",
      "amountBtc": "0",
      "apl": "0",
      "avgCost": "0"
    },
    {
      "id": 1383,
      "balanceType": "SPOT",
      "total": "31644",
      "asset": {
        "id": 8147,
        "name": "BTTC",
        "code": "BTTC",
        "icon": "https://cdn.raydar.app/icons/BTTC.png"
      },
      "walletId": 1,
      "exchangeId": 2,
      "amount": "0",
      "amountBtc": "0",
      "apl": "0",
      "avgCost": "0"
    }
  ],
  "itemCount": 119
}

MyCoins Get user’s coins

  • Url: http://localhost:8181/swagger/index.html#/users/MyCoins
  • The endpoint used is api/v1/users/me/coins [get]
  • Query parameters accepted: offset, limit, exchangeId, walletId, type, coinId, and sort.
    • offset: Determines the starting point for pagination. default(0)
    • limit: Specifies the maximum number of exchanges to return. default(10)
    • exchangeId: Filters by Exchange ID.
    • coinId: Filters by Coin ID.
    • walletId: Filters by Wallet ID.
    • type: Specifies the transaction type. SPOT: Spot trading, MARGIN: Margin trading, FUTURE: Futures trading, EARN: Earn transactions.
    • sort: Used for sorting. total: Ascending order, total-: Descending order, amount: Ascending order, amount-: Descending order, exchangeCount: Ascending order, exchangeCount-: Descending order.

Response Example:

{
  "coins": [
    {
      "id": 3,
      "code": "USDT",
      "name": "Tether USDt",
      "total": "12.832195209920028518",
      "amount": "463.190918297273349385728",
      "amountBtc": "0",
      "exchangeCount": 12,
      "exchangeUrls": [
        "https://cdn.raydar.app/icons/htx.svg",
        "https://cdn.raydar.app/icons/kucoin.svg",
        "https://cdn.raydar.app/icons/okx.svg",
        "https://cdn.raydar.app/icons/kraken.svg",
        "https://cdn.raydar.app/icons/bingx.svg",
        "https://cdn.raydar.app/icons/okxTR.svg",
        "https://cdn.raydar.app/icons/bitget.svg",
        "https://cdn.raydar.app/icons/binance.svg",
        "https://cdn.raydar.app/icons/cryptocom.svg",
        "https://cdn.raydar.app/icons/cointr.svg",
        "https://cdn.raydar.app/icons/bitexen.svg",
        "https://cdn.raydar.app/icons/binanceTR.svg"
      ],
      "openOrdersCount": 2,
      "icon": "https://cdn.raydar.app/icons/USDT.png",
      "isFavorite": true,
      "lastTradeTime": 1734734573766,
      "tradePrice": "0",
      "apl": "0",
      "avgCost": "0"
    }
  ],
  "itemCount": 72
}

MyFavoriteCoins Get favorite coins

Response Example:

{
  "assets": [
    {
      "id": 1,
      "name": "Bitcoin",
      "code": "BTC",
      "icon": "https://cdn.raydar.app/icons/BTC.png"
    },
    {
      "id": 7,
      "name": "XRP",
      "code": "XRP",
      "icon": "https://cdn.raydar.app/icons/XRP.png"
    }
  ],
  "itemCount": 5
}

AddFavoriteCoins Add a favorite coin

RemoveFavoriteCoins Remove a favorite coin

GetPopularCoins Get popular coins

Response Example:

{
  "assets": [
    {
      "id": 1,
      "name": "Bitcoin",
      "code": "BTC",
      "icon": "https://cdn.raydar.app/icons/BTC.png"
    },
    {
      "id": 2,
      "name": "Ethereum",
      "code": "ETH",
      "icon": "https://cdn.raydar.app/icons/ETH.png"
    }
  ],
  "itemCount": 10
}

MyCoin get a specific coin

Response Example:

{
  "coins": [
    {
      "id": 3,
      "code": "USDT",
      "name": "Tether USDt",
      "total": "2.11006085",
      "amount": "76.1647564416",
      "amountBtc": "0",
      "exchange": {
        "id": 2,
        "name": "Binance",
        "exchangeIcon": "https://cdn.raydar.app/icons/binance.svg",
        "exchangeLogo": "https://cdn.raydar.app/icons/binance_logo.svg",
        "baseUrl": "https://www.binance.com/en",
        "credentialInfo": null
      },
      "icon": "https://cdn.raydar.app/icons/USDT.png",
      "isFavorite": true
    }
  ]
}

DepositWithdrawalChart Get deposit and withdrawal chart

Response Example:

{
  "data": [
    {
      "name": "2022-12",
      "deposit": "1100",
      "withdraw": "0"
    },
    {
      "name": "2023-02",
      "deposit": "49950",
      "withdraw": "0"
    },
    {
      "name": "2024-08",
      "deposit": "297.124",
      "withdraw": "0"
    }
  ]
}

MyExchanges get a list of user’s exchanges

  • Url: http://localhost:8181/swagger/index.html#/users/MyExchanges
  • The endpoint used is api/v1/users/me/exchanges [get]
  • Query parameters offset, limit, exchangeId, coinId, and sort are accepted.
    • offset: Defines the starting point for pagination. default(0)
    • limit: Sets the maximum number of exchanges to return. default(10)
    • exchangeId: Filters by Exchange ID.
    • coinId: Filters by Coin ID.
    • sort: Used for sorting. coinCount: Ascending order, coinCount-: Descending order, amount: Ascending order, amount-: Descending order.

Response Example:

{
  "exchanges": [
    {
      "id": 4,
      "amount": "429.2630634156000004608",
      "amountBtc": "0",
      "coinCount": 32,
      "totalCoin": "473616.23390239",
      "openOrderCount": 0,
      "closeOrderCount": 3,
      "icon": "https://cdn.raydar.app/icons/binanceTR.svg",
      "price": "0",
      "logo": "https://cdn.raydar.app/icons/binanceTR_logo.svg",
      "name": "Binance-Tr",
      "coinIcons": [
        "https://cdn.raydar.app/icons/TRY.png",
        "https://cdn.raydar.app/icons/LTC.png",
        "https://cdn.raydar.app/icons/USDT.png",
        "https://cdn.raydar.app/icons/BNB.png",
        "https://cdn.raydar.app/icons/DOGE.png"
      ],
      "apl": "0",
      "avgCost": "0"
    }
  ],
  "itemCount": 14
}

MyMembership Get user membership details

Response Example:

{
  "id": 32,
  "userId": 2,
  "membership": {
    "id": 11,
    "name": "LifeTime Elite Plan",
    "attributes": {
      "advanced_reports": true,
      "arbitrage_access": true,
      "commissions": true,
      "manual_sync": 1000,
      "max_accounts": 10000,
      "real_time_tracking": true,
      "reports": 1000,
      "transaction_history": 2000000
    },
    "description": {
      "en": "LifeTime Plan - 10,000 crypto exchange account binding, 2 million transaction history views, real-time asset tracking; no page refresh required, access to advanced reports, access to commission/volume data, unlimited access to arbitrage page, automatic open order synchronization, unlimited times.",
      "tr": "Elite Paket - 10,000 kripto borsa hesabı bağlama, 2 milyon işlem geçmişi görüntüleme, real-time varlık takibi; sayfa yenilemeye gerek yok, gelişmiş raporlara erişim, komisyonlar ve hacim verilerine erişim, arbitraj sayfasına sınırsız erişim, açık emir senkronizasyonu otomatik, sınırsız."
    },
    "isActive": true,
    "price": "399.99",
    "basePrice": "999.99",
    "type": "ELITE",
    "period": 3650
  },
  "expirationAt": 2049975865839,
  "isActive": true,
  "price": "399.99"
}

UpdateUserPassword Update the current user’s password

Response Example:

{
  "newPassword": "string",
  "oldPassword": "string"
}

MyPayments Get user payment transactions

  • Url: http://localhost:8181/swagger/index.html#/users/MyPayments
  • The endpoint used is api/v1/users/me/payments [get]
  • Query parameters offset and limit are accepted.
    • offset: Specifies the starting point for pagination. default(0)
    • limit: Specifies the maximum number of exchanges to return. default(10)

Response Example:

{
  "transactions": [
    {
      "id": 255,
      "status": "PENDING",
      "referenceNo": "cs_test_a1QKTjVK9tMeLH2wNWCtQNSTQSBREI75NFvvORzxY0ZOw6LhY48Rz8QIAK",
      "createdAt": 1739432772819,
      "updatedAt": 1739432772819
    },
    {
      "id": 254,
      "status": "PENDING",
      "referenceNo": "ATW220250213103616",
      "createdAt": 1739432176772,
      "updatedAt": 1739432176772
    }
  ],
  "itemCount": 180
}

MyStats Get user statistics

Response Example:

{
  "id": 1,
  "userId": 2,
  "walletCount": 31,
  "transactionCount": 1905,
  "syncCount": 147096,
  "dailySyncCount": 7
}
coinpays

Callback Coinpays payment response

GetPaymentToken Get a payment token

Response Example:

{
  "token": "Z0BvcDZCp6bHUT0=",
  "status": "success"
}
currencies

GetCurrencies Get all currencies

Response Example:

{
  "currencies": [
    {
      "id": 31,
      "name": "Euro",
      "code": "EUR",
      "symbol": "€",
      "icon": "https://cdn.raydar.app/icons/EUR.png"
    },
    {
      "id": 1,
      "name": "US dollar",
      "code": "USD",
      "symbol": "$",
      "icon": "https://cdn.raydar.app/icons/USD.png"
    }
  ]
}

GetCurrency Get a currency

Response Example:

{
  "id": 1,
  "name": "US dollar",
  "code": "USD",
  "symbol": "$",
  "icon": "https://cdn.raydar.app/icons/USD.png"
}
exchanges

GetExchanges Get all exchanges

  • Url: http://localhost:8181/swagger/index.html#/exchanges/GetExchanges
  • The endpoint used is api/v1/exchanges [get]
  • Query parameters accepted: offset, limit, search, and sort.
    • offset: Defines the starting point for pagination. default(0)
    • limit: Determines the maximum number of assets to be returned. default(10)
    • search: Searches for assets by code. If not specified, all assets are retrieved.
    • sort: Used for sorting assets. code: Ascending order, code-: Descending order.

Response Example:

{
  "exchanges": [
    {
      "id": 1,
      "name": "BingX",
      "exchangeIcon": "https://cdn.raydar.app/icons/bingx.svg",
      "exchangeLogo": "https://cdn.raydar.app/icons/bingx_logo.svg",
      "baseUrl": "https://bingx.com/",
      "credentialInfo": {
        "apiKey": "string",
        "secretKey": "string"
      }
    },
    {
      "id": 2,
      "name": "Binance",
      "exchangeIcon": "https://cdn.raydar.app/icons/binance.svg",
      "exchangeLogo": "https://cdn.raydar.app/icons/binance_logo.svg",
      "baseUrl": "https://www.binance.com/en",
      "credentialInfo": {
        "apiKey": "string",
        "secretKey": "string"
      }
    }
  ],
  "itemCount": 18
}

GetExchange Get an exchange

Response Example:

{
  "id": 2,
  "name": "Binance",
  "exchangeIcon": "https://cdn.raydar.app/icons/binance.svg",
  "exchangeLogo": "https://cdn.raydar.app/icons/binance_logo.svg",
  "baseUrl": "https://www.binance.com/en",
  "credentialInfo": {
    "apiKey": "string",
    "secretKey": "string"
  }
}
membership

Memberships get memberships

Response Example:

{
  "monthly": [
    {
      "id": 11,
      "name": "LifeTime Elite Plan",
      "attributes": {
        "advanced_reports": true,
        "arbitrage_access": true,
        "commissions": true,
        "manual_sync": 1000,
        "max_accounts": 10000,
        "real_time_tracking": true,
        "reports": 1000,
        "transaction_history": 2000000
      },
      "description": {
        "en": "LifeTime Plan - 10,000 crypto exchange account binding, 2 million transaction history views, real-time asset tracking; no page refresh required, access to advanced reports, access to commission/volume data, unlimited access to arbitrage page, automatic open order synchronization, unlimited times.",
        "tr": "Elite Paket - 10,000 kripto borsa hesabı bağlama, 2 milyon işlem geçmişi görüntüleme, real-time varlık takibi; sayfa yenilemeye gerek yok, gelişmiş raporlara erişim, komisyonlar ve hacim verilerine erişim, arbitraj sayfasına sınırsız erişim, açık emir senkronizasyonu otomatik, sınırsız."
      },
      "isActive": true,
      "price": "399.99",
      "basePrice": "999.99",
      "type": "ELITE",
      "period": 3650
    }
  ],
  "yearly": [
    {
      "id": 11,
      "name": "LifeTime Elite Plan",
      "attributes": {
        "advanced_reports": true,
        "arbitrage_access": true,
        "commissions": true,
        "manual_sync": 1000,
        "max_accounts": 10000,
        "real_time_tracking": true,
        "reports": 1000,
        "transaction_history": 2000000
      },
      "description": {
        "en": "LifeTime Plan - 10,000 crypto exchange account binding, 2 million transaction history views, real-time asset tracking; no page refresh required, access to advanced reports, access to commission/volume data, unlimited access to arbitrage page, automatic open order synchronization, unlimited times.",
        "tr": "Elite Paket - 10,000 kripto borsa hesabı bağlama, 2 milyon işlem geçmişi görüntüleme, real-time varlık takibi; sayfa yenilemeye gerek yok, gelişmiş raporlara erişim, komisyonlar ve hacim verilerine erişim, arbitraj sayfasına sınırsız erişim, açık emir senkronizasyonu otomatik, sınırsız."
      },
      "isActive": true,
      "price": "399.99",
      "basePrice": "999.99",
      "type": "ELITE",
      "period": 3650
    }
  ]
}
orders

GetOrders Get orders

  • Url: http://localhost:8181/swagger/index.html#/orders/GetOrders
  • The endpoint used is api/v1/orders [get]
  • Query parameters accepted: offset, limit, walletId, coinId, symbolId, exchangeId, startDate, endDate, sort, side, type and status.
    • offset: Defines the starting point for pagination. default(0)
    • limit: Determines the maximum number of orders to be returned. default(10)
    • walletId: Filters by Wallet ID.
    • coinId: Filters by Coin ID.
    • symbolId: Filters by Symbol ID.
    • exchangeId: Filters by Exchange ID.
    • startDate: Retrieves orders after the specified date.
    • endDate: Retrieves orders up to the specified date.
    • sort: Used for sorting. price: Ascending price order. price-: Descending price order. quantity: Ascending quantity order. quantity-: Descending quantity order. time: Ascending time order. time-: Descending time order.
    • side: Filters by order type: Buy or Sell orders.
    • type: Order type. limit: Orders placed at a specific price. market: Orders placed at the current market price.
    • status: Filters by order status. Open: List open orders, Closed: List closed orders.

Response Example:

{
  "orders": [
    {
      "id": 15184,
      "orderId": "744026361375",
      "orderType": "SPOT",
      "baseAsset": {
        "id": 7,
        "name": "XRP",
        "code": "XRP",
        "icon": "https://cdn.raydar.app/icons/XRP.png"
      },
      "targetAsset": {
        "id": 8146,
        "name": "TRY",
        "code": "TRY",
        "icon": "https://cdn.raydar.app/icons/TRY.png"
      },
      "type": "LIMIT",
      "price": "100.0116999999999986347",
      "side": "SELL",
      "status": "OPEN",
      "time": 1733323963195,
      "executedQTY": "0",
      "quantity": "3.884",
      "walletId": 762,
      "walletName": "GateTR Wallet",
      "exchange": {
        "id": 6,
        "name": "Gate-Tr",
        "exchangeIcon": "https://cdn.raydar.app/icons/gateTR.svg",
        "exchangeLogo": "https://cdn.raydar.app/icons/gateTR_logo.svg",
        "baseUrl": "https://www.gate.com.tr/",
        "credentialInfo": null
      },
      "totalAmount": "0",
      "currentPrice": "0",
      "totalCommission": "0",
      "totalCommissionBtc": "0",
      "remainQuantity": "3.884"
    }
  ],
  "itemCount": 411
}

GetOrdersSummary Get orders summary

Response Example:

{
  "totalVolume": "310862.87820564855660225238",
  "totalVolumeBtc": "0",
  "totalBuyVolume": "105923.45789967999999966997",
  "totalBuyVolumeBtc": "0",
  "totalSellVolume": "204939.42030596855660258241",
  "totalSellVolumeBtc": "0",
  "currentVolume": "1182030.0978424438553281536",
  "totalCommission": "20.9604360473539791",
  "totalCommissionBtc": "0",
  "exchangeUrls": [
    "https://cdn.raydar.app/icons/binance.svg"
  ],
  "coinUrls": [
    "https://cdn.raydar.app/icons/BNB.png",
    "https://cdn.raydar.app/icons/ETH.png",
    "https://cdn.raydar.app/icons/BTTC.png"
  ]
}
region

GetRegions Get all regions

Response Example:

{
  "regions": [
    {
      "id": 2,
      "name": "United States of America",
      "code": "EN",
      "locale": "en",
      "icon": "/flags/United-states_flag.svg",
      "title": "English"
    },
    {
      "id": 1,
      "name": "Turkey",
      "code": "TR",
      "locale": "tr",
      "icon": "/flags/Flag_of_Turkey.svg",
      "title": "Turkish"
    }
  ]
}

GetRegion Get a region

Response Example:

{
  "id": 2,
  "name": "United States of America",
  "code": "EN",
  "locale": "en",
  "icon": "/flags/United-states_flag.svg",
  "title": "English"
}
stripe

Callback Stripe payment response

Checkout Stripe checkout

Response Example:

{
  "checkout_url": "string"
}
symbol

GetSymbols Get symbols

  • Url: http://localhost:8181/swagger/index.html#/symbols/GetSymbols
  • The endpoint used is api/v1/symbols [get]
  • Query parameters accepted: offset, limit, coinId, search and sort.
    • offset: Defines the starting point for pagination. default(0)
    • limit: Determines the maximum number of exchanges to be returned. default(10)
    • coinId: Filters by Coin ID.
    • search: Allows searching by exchange name.
    • sort: Used for sorting. name: Ascending order, name-: Descending order.

Response Example:

{
  "symbols": [
    {
      "id": 8751,
      "name": "$1USDT",
      "baseAsset": 9781,
      "targetAsset": 3
    },
    {
      "id": 5746,
      "name": "$BAR_OLDUSDT",
      "baseAsset": 8850,
      "targetAsset": 3
    }
  ],
  "itemCount": 8790
}

GetSymbol Get a symbol

Response Example:

{
  "id": 8751,
  "name": "$1USDT",
  "baseAsset": 9781,
  "targetAsset": 3
}
trade

GetTrades Get trades

  • Url: http://localhost:8181/swagger/index.html#/trades/GetTrades
  • The endpoint used is api/v1/trades [get]
  • Query parameters accepted: offset, limit, walletId, coinId, exchangeId, startDate, endDate, sort, isBuyer, type and orderId.
    • offset: Defines the starting point for pagination. default(0)
    • limit: Determines the maximum number of orders to be returned. default(10)
    • walletId: Filters by Wallet ID.
    • coinId: Filters by Coin ID.
    • symbolId: Filters by Symbol ID.
    • exchangeId: Filters by Exchange ID.
    • startDate: Retrieves orders after the specified date.
    • endDate: Retrieves orders up to the specified date.
    • sort: Used for sorting. price: Ascending price order. price-: Descending price order. quantity: Ascending quantity order. quantity-: Descending quantity order. totalPrice: Ascending order. totalPrice-: Descending order. commission: Ascending order. commission-: Descending order. time: Ascending time order. time-: Descending time order.
    • isBuyer: Filters by buyer or seller. true: Buyer, false: Seller.
    • type: Specifies the transaction type. DEPOSIT: Deposit, WITHDRAW: Withdraw, FIATBUY: Buy with fiat, FIATSELL: Sell with fiat, TRANSFERIN: Transfer (in), TRANSFEROUT: Transfer (out), TRADE.
    • orderId: Filters by the specified Order ID.

Response Example:

{
  "transactions": [
    {
      "id": 7737,
      "orderId": "744025669255",
      "isBuyer": true,
      "isMaker": false,
      "isManual": false,
      "price": "89.8315000000000003543",
      "quantity": "3.888",
      "totalPrice": "349.2648720000000002931",
      "totalCurrentPrice": "140.341248",
      "baseAsset": {
        "id": 7,
        "name": "XRP",
        "code": "XRP",
        "icon": "https://cdn.raydar.app/icons/XRP.png"
      },
      "targetAsset": {
        "id": 8146,
        "name": "TRY",
        "code": "TRY",
        "icon": "https://cdn.raydar.app/icons/TRY.png"
      },
      "time": 1733323915573,
      "commission": "0.003888",
      "commissionCurrency": "XRP",
      "commissionFiat": "0",
      "wallet": {
        "id": 762,
        "name": "GateTR Wallet",
        "exchange": {
          "id": 6,
          "name": "Gate-Tr",
          "exchangeIcon": "https://cdn.raydar.app/icons/gateTR.svg",
          "exchangeLogo": "https://cdn.raydar.app/icons/gateTR_logo.svg",
          "baseUrl": "https://www.gate.com.tr/",
          "credentialInfo": null
        }
      },
      "type": "TRADE",
      "baseAssetCurrentPrice": "36.096",
      "targetAssetCurrentPrice": "0",
      "totalBtc": "0"
      }
    ],
    "itemCount": 1160
}

GetTradesSummary Get trades summary

  • Url: http://localhost:8181/swagger/index.html#/trades/GetTradesSummary
  • The endpoint used is /v1/trades/summary [get]
  • Query parameters accepted: walletId, coinId, exchangeId, startDate, endDate, sort, isBuyer, type and orderId.
    • walletId: Filters by Wallet ID.
    • coinId: Filters by Coin ID.
    • exchangeId: Filters by Exchange ID.
    • startDate: Retrieves transactions after the specified date.
    • endDate: Retrieves transactions up to the specified date.
    • sort: Used for sorting. price: Ascending price order, price-: Descending price order, quantity: Ascending quantity order, quantity-: Descending quantity order, totalPrice: Ascending order, totalPrice-: Descending order, commission: Ascending order, commission-: Descending order, time: Ascending time order, time-: Descending time order.
    • isBuyer: Filters by buyer or seller. true: Buyer, false: Seller.
    • type: Specifies the transaction type. FIATBUY: Buy with fiat, TRANSFERIN: Transfer (in), TRANSFEROUT: Transfer (out), TRADE: Trade.
    • orderId: Filters by the specified Order ID.

Response Example:

{
  "totalVolume": "13092324.73195402669117296966",
  "totalVolumeBtc": "0",
  "totalInboundVolume": "6316992.22645118065697028372",
  "totalInboundVolumeBtc": "0",
  "totalOutboundVolume": "6775332.50550284603420268594",
  "totalOutboundVolumeBtc": "0",
  "totalCommission": "40488.01037975851980326448",
  "totalCommissionBtc": "0",
  "exchangeCount": 15,
  "coinCount": 16,
  "exchangeUrls": [
    "https://cdn.raydar.app/icons/bingx.svg"
  ],
  "coinUrls": [
    "https://cdn.raydar.app/icons/ETH.png"
  ]
}

GetTrade Get a trade

Response Example:

{
  "transactions": [
    {
      "id": 7737,
      "orderId": "744025669255",
      "isBuyer": true,
      "isMaker": false,
      "isManual": false,
      "price": "89.8315000000000003543",
      "quantity": "3.888",
      "totalPrice": "349.2648720000000002931",
      "totalCurrentPrice": "140.341248",
      "baseAsset": {
        "id": 7,
        "name": "XRP",
        "code": "XRP",
        "icon": "https://cdn.raydar.app/icons/XRP.png"
      },
      "targetAsset": {
        "id": 8146,
        "name": "TRY",
        "code": "TRY",
        "icon": "https://cdn.raydar.app/icons/TRY.png"
      },
      "time": 1733323915573,
      "commission": "0.003888",
      "commissionCurrency": "XRP",
      "commissionFiat": "0",
      "wallet": {
        "id": 762,
        "name": "GateTR Wallet",
        "exchange": {
          "id": 6,
          "name": "Gate-Tr",
          "exchangeIcon": "https://cdn.raydar.app/icons/gateTR.svg",
          "exchangeLogo": "https://cdn.raydar.app/icons/gateTR_logo.svg",
          "baseUrl": "https://www.gate.com.tr/",
          "credentialInfo": null
        }
      },
      "type": "TRADE",
      "baseAssetCurrentPrice": "36.096",
      "targetAssetCurrentPrice": "0",
      "totalBtc": "0"
      }
    ],
    "itemCount": 1160
}
wallet

GetWallets Get wallets

  • Url: http://localhost:8181/swagger/index.html#/wallets/GetWallets
  • The endpoint used is api/v1/wallets [get]
  • Query parameters accepted: offset, limit, exchangeId, search, sort.
    • offset: Defines the starting point for pagination. default(0)
    • limit: Determines the maximum number of exchanges to be returned. default(10)
    • exchangeId: Filters by Exchange ID.
    • coinId: Filters by Coin ID.
    • sort: Used for sorting. amount: Ascending order. amount-: Descending order. coinCount: Ascending order. coinCount-: Descending order. id: Ascending order. id-: Descending order. syncDate: Ascending order. syncDate-: Descending order.

Response Example:

{
  "wallets": [
    {
      "id": 1,
      "exchange": {
        "id": 2,
        "name": "Binance",
        "exchangeIcon": "https://cdn.raydar.app/icons/binance.svg",
        "exchangeLogo": "https://cdn.raydar.app/icons/binance_logo.svg",
        "baseUrl": "https://www.binance.com/en",
        "credentialInfo": {
          "apiKey": "string",
          "secretKey": "string"
        }
      },
      "name": "Binance Wallet",
      "deposit": "764388.0680044050367693824",
      "depositBtc": "0",
      "withdrawal": "0",
      "withdrawBtc": "0",
      "commission": "58775.004723857566142479689096576",
      "commissionBtc": "0",
      "currencyId": 1,
      "isActive": true,
      "isSync": true,
      "syncDate": 1729625988000,
      "totalBalance": "115.02088472832",
      "totalBtc": "0",
      "coinCount": 37,
      "coinIcons": [
        "https://cdn.raydar.app/icons/DOGE.png",
        "https://cdn.raydar.app/icons/BNB.png",
        "https://cdn.raydar.app/icons/BTTC.png",
        "https://cdn.raydar.app/icons/USDT.png",
      ],
      "spotBalance": "1.3476766464",
      "spotBtc": "0",
      "marginBalance": "74.8170797952",
      "marginBtc": "0",
      "futuresBalance": "0",
      "futuresBtc": "0",
      "earnBalance": "38.85612828672",
      "earnBtc": "0"
    }
  ],
  "totalBalance": "712.155456863715206056704",
  "totalBtc": "0",
  "totalDeposit": "1129487.6401362492222687983123712",
  "totalDepositBtc": "0",
  "totalWithdraw": "1138163.287351930288045676546487552",
  "totalWithdrawBtc": "0",
  "totalCommission": "59526.154756961804598476014114176",
  "totalCommissionBtc": "0",
  "itemCount": 16
}

CreateWallet Create a new wallet

Response Example:

{
  "wallets": [
    {
      "id": 1,
      "exchange": {
        "id": 2,
        "name": "Binance",
        "exchangeIcon": "https://cdn.raydar.app/icons/binance.svg",
        "exchangeLogo": "https://cdn.raydar.app/icons/binance_logo.svg",
        "baseUrl": "https://www.binance.com/en",
        "credentialInfo": {
          "apiKey": "string",
          "secretKey": "string"
        }
      },
      "name": "Binance Wallet",
      "deposit": "764388.0680044050367693824",
      "depositBtc": "0",
      "withdrawal": "0",
      "withdrawBtc": "0",
      "commission": "58775.004723857566142479689096576",
      "commissionBtc": "0",
      "currencyId": 1,
      "isActive": true,
      "isSync": true,
      "syncDate": 1729625988000,
      "totalBalance": "115.02088472832",
      "totalBtc": "0",
      "coinCount": 37,
      "coinIcons": [
        "https://cdn.raydar.app/icons/DOGE.png",
        "https://cdn.raydar.app/icons/BNB.png",
        "https://cdn.raydar.app/icons/BTTC.png",
        "https://cdn.raydar.app/icons/USDT.png",
      ],
      "spotBalance": "1.3476766464",
      "spotBtc": "0",
      "marginBalance": "74.8170797952",
      "marginBtc": "0",
      "futuresBalance": "0",
      "futuresBtc": "0",
      "earnBalance": "38.85612828672",
      "earnBtc": "0"
    }
  ],
  "totalBalance": "712.155456863715206056704",
  "totalBtc": "0",
  "totalDeposit": "1129487.6401362492222687983123712",
  "totalDepositBtc": "0",
  "totalWithdraw": "1138163.287351930288045676546487552",
  "totalWithdrawBtc": "0",
  "totalCommission": "59526.154756961804598476014114176",
  "totalCommissionBtc": "0",
  "itemCount": 16
}

GetWallet Get a wallet

Response Example:

{
  "id": 1,
  "exchange": {
    "id": 2,
    "name": "Binance",
    "exchangeIcon": "https://cdn.raydar.app/icons/binance.svg",
    "exchangeLogo": "https://cdn.raydar.app/icons/binance_logo.svg",
    "baseUrl": "https://www.binance.com/en",
    "credentialInfo": {
      "apiKey": "string",
      "secretKey": "string"
    }
  },
  "name": "Binance Wallet",
  "deposit": "764388.0680044050367693824",
  "depositBtc": "0",
  "withdrawal": "0",
  "withdrawBtc": "0",
  "commission": "58775.004723857566142479689096576",
  "commissionBtc": "0",
  "currencyId": 1,
  "isActive": true,
  "isSync": true,
  "syncDate": 1729625988000,
  "totalBalance": "115.02088472832",
  "totalBtc": "0",
  "coinCount": 37,
  "coinIcons": [
    "https://cdn.raydar.app/icons/DOGE.png",
    "https://cdn.raydar.app/icons/BNB.png",
    "https://cdn.raydar.app/icons/BTTC.png",
    "https://cdn.raydar.app/icons/USDT.png",
  ],
  "spotBalance": "1.3476766464",
  "spotBtc": "0",
  "marginBalance": "74.8170797952",
  "marginBtc": "0",
  "futuresBalance": "0",
  "futuresBtc": "0",
  "earnBalance": "38.85612828672",
  "earnBtc": "0"
}

UpdateWallet Update a wallet

Response Example:

{
  "coinCount": 0,
  "coinIcons": [
    "string"
  ],
  "commission": "string",
  "commissionBtc": "string",
  "credentialInfo": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "currencyId": 0,
  "deposit": "string",
  "depositBtc": "string",
  "earnBalance": "string",
  "earnBtc": "string",
  "exchange": {
    "baseUrl": "string",
    "credentialInfo": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "exchangeIcon": "string",
    "exchangeLogo": "string",
    "id": 0,
    "name": "string"
  },
  "futuresBalance": "string",
  "futuresBtc": "string",
  "id": 0,
  "isActive": true,
  "isSync": true,
  "marginBalance": "string",
  "marginBtc": "string",
  "name": "string",
  "spotBalance": "string",
  "spotBtc": "string",
  "syncDate": 0,
  "totalBalance": "string",
  "totalBtc": "string",
  "withdrawBtc": "string",
  "withdrawal": "string"
}

DeleteWallet Delete a wallet

WalletBalances Get balances of wallet

  • Url: http://localhost:8181/swagger/index.html#/wallets/WalletBalances
  • The endpoint used is api/v1/wallets/{id}/balances/{type} [get]
  • Query parameters accepted: coinId, sort.
    • coinId: Filters by Coin ID.
    • sort: Used for sorting. total: Ascending order. total-: Descending order. amount: Ascending order. amount-: Descending order.
  • Path Parameters:
    • id: The ID of the wallet.
    • type: The type of balance.

Response Example:

{
  "balances": [
    {
      "id": 1,
      "balanceType": "SPOT",
      "total": "11075.7700761",
      "asset": {
        "id": 8,
        "name": "Dogecoin",
        "code": "DOGE",
        "icon": "https://cdn.raydar.app/icons/DOGE.png"
      },
      "walletId": 1,
      "exchangeId": 2,
      "amount": "0",
      "amountBtc": "0",
      "apl": "0",
      "avgCost": "0"
    },
    {
      "id": 848,
      "balanceType": "SPOT",
      "total": "0.0373359",
      "asset": {
        "id": 3,
        "name": "Tether USDt",
        "code": "USDT",
        "icon": "https://cdn.raydar.app/icons/USDT.png"
      },
      "walletId": 1,
      "exchangeId": 2,
      "amount": "1.3476766464",
      "amountBtc": "0",
      "apl": "0",
      "avgCost": "0"
    }
  ],
  "itemCount": 9
}

SyncWallet Sync a wallet

SyncWalletStatus Wallet sync status

Response Example:

{
  "status": "SYNCING"
}
centrifugo

Login user ws token

  • The endpoint used is /api/v1/ws/login [get]
  • Allows users to authenticate for a WebSocket connection.
  • Generates a token for the user.

Response Example:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5Lug9rhc6M0kie0",
  "expires_in": 1731234251144
}