Whales

Get whales returns large crypto trades for a crypto pair from an exchange.

The whales endpoint is in beta. We do not recommend use in production.

Get Whales

GET https://api.abyiss.com/v2/whales/{exchange}/{market}

Returns an object containing large crypto trades for a crypto pair on an exchange.

Path Parameters

Name	Type	Description
exchange*	string	Unique exchange identifier used by Abyiss.
market*	string	Unique Crypto Pair identifier used by the exchange.

Query Parameters

Name	Type	Description
apiKey*	string	Your Abyiss API Key

200: OK Success

{
    "name": "BTC-USD",
    "exchangeId": "coinbasepro",
    "base": "BTC",
    "quote": "USD",
    "whales": {
        "nodes": [
            {
                "cost": 220116.966516,
                "id": 18332,
                "idOnExchange": "456861288",
                "insertedAt": "2022-11-17T15:49:18.878",
                "price": 16560,
                "side": "buy",
                "size": 13.29208735
            },
        ]
    }
}

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Get Whales Today

GET https://api.abyiss.com/v2/whales/today

Returns an object containing the most recent or newest top 50 large crypto trades within the day.

Query Parameters

Name	Type	Description
apiKey*	string	Your Abyiss API Key

200: OK Success

{
    "cost": 313438.248,
    "id": 18336,
    "idOnExchange": "1025921603",
    "insertedAt": "2022-11-18T05:21:40.879",
    "market": {
        "name": "ETH-USDT",
        "exchangeId": "binance",
        "base": "ETH",
        "quote": "USDT"
    },
    "price": 1224,
    "side": "sell",
    "size": 256.077
},

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Copy & Paste Code

Curl

curl -H "apiKey: API KEY" https://api.abyiss.com/v2/whales/coinbasepro/btc-usd

Python

import urllib.request
url = "https://api.abyiss.com/v2/whales/coinbasepro/btc-usd?apiKey=*"
print(urllib.request.urlopen(url).read())

JavaScript

fetch("https://api.abyiss.com/v2/whales/coinbasepro/btc-usd?apiKey=*")
  .then(response => response.json())
  .then(data => console.log(data))

Node.js

require('axios')
  .get("https://api.abyiss.com/v2/whales/coinbasepro/btc-usd?apiKey=*")
  .then(response => console.log(response))

Ruby

require 'net/http'
uri = URI("https://api.abyiss.com/v2/whales/coinbasepro/btc-usd?apiKey=*")
puts Net::HTTP.get(uri)

Response Object

Whales

Example URL: https://api.abyiss.com/v2/whales/coinbasepro/btc-usd?apiKey=

{
    "name": "BTC-USD",
    "exchangeId": "coinbasepro",
    "base": "BTC",
    "quote": "USD",
    "whales": {
        "nodes": [
            {
                "cost": 220116.966516,
                "id": 18332,
                "idOnExchange": "456861288",
                "insertedAt": "2022-11-17T15:49:18.878",
                "price": 16560,
                "side": "buy",
                "size": 13.29208735
            },
        ]
    }
}

Whales Today

Example URL: https://api.abyiss.com/v2/whales/today?apiKey=

{
    "cost": 313438.248,
    "id": 18336,
    "idOnExchange": "1025921603",
    "insertedAt": "2022-11-18T05:21:40.879",
    "market": {
        "name": "ETH-USDT",
        "exchangeId": "binance",
        "base": "ETH",
        "quote": "USDT"
    },
    "price": 1224,
    "side": "sell",
    "size": 256.077
},

Response Attributes

Attribute Name	Data Type	Description
name	string	Unique identifier used by the exchange for ticker.
exchangeId	string	The exchange id.
base	string	The base of the market. eg: The quantity that is bought.
quote	string	The quote of the market. eg: The currency being compared.
cost	integer	The quote cost: (size * price).
id	integer	The exchange specific unique id of the trade.
idOnExchange	string	Unique identifier used by the exchange for trade.
insertedAt	string	Unix timestamp of the trade.
price	integer	The price the trade was executed at.
side	string	Whether the trade was a buy or sell.
size	integer	The quantity traded.