Liquidity

Get liquidity returns the total liquidity for a crypto pair on an exchange.

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

Get Liquidity

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

Returns an object containing the total liquidity 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

{
    "exchange": "coinbasepro",
    "market": "BTC-USD",
    "nonce": 5640375978,
    "liquidity": 37224813.18828725
}

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Copy & Paste Code

Curl

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

Python

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

JavaScript

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

Node.js

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

Ruby

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

Response Object

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

{
    "exchange": "coinbasepro",
    "market": "BTC-USD",
    "nonce": 5640375978,
    "liquidity": 37224813.18828725
}

Response Attributes

Attribute Name	Data Type	Description
exchange	string	The exchange id.
market	string	The crypto pair.
nonce	integer	The serial unique identifier of the order book on the exchange.
liquidity	integer	The total liquidity for a crypto market pair.