API Reference

Create Perpetuals Spread Hook

post
https://b2b-api-dev.arbitragescanner.io/api/screener/v1/live/perpetuals/spread-hook

Creates a web hook to stream futures arbitrage events in real time to your server

  • Important: the data sent to the webhook is compressed with gzip - keep this in mind when deserializing messages.
  • Note: An example of the data structure sent to the webhook is given in the webhook event section.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
blacklisted_currencies
array of strings

List of cryptocurrency tickers to exclude from the data

  • you can leave this field blank or skip it at all

Blacklisted Currencies
whitelisted_currencies
array of strings

List of cryptocurrency tickers to limit the data to.

  • you can leave this field blank or skip it at all

Whitelisted Currencies
0.2 to 100

Max profit percentage

0.2 to 100

Max profit percentage

≥ 50

Minimum deal volume in USD

≥ 50

Maximum deal volume in USD

≥ 1

Minimum time of spread existence in milliseconds

≥ 1000

Maximum time of spread existence in milliseconds

uri
required
length between 1 and 2083

Hook URL

buy_exchanges
array of objects
required

List of exchanges for buying an asset

Buy Exchanges*
sell_exchanges
array of objects
required

List of exchanges for selling an asset

Sell Exchanges*
mode
array of objects
required
  • f-f - futures-futures: buying on futures, selling on futures
  • f-s - futures-spot: buying on futures, selling on spot
  • s-f - spot-futures: buying on spot, selling on futures
Mode*
Response

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago