Create Spot Spread Hook

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

Creates a web hook to stream spot 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.

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

max_profit_percent

number

required

0.2 to 100

Max profit percentage

min_profit_percent

number

required

0.2 to 100

Max profit percentage

min_deal_amount

integer

required

≥ 50

Minimum deal volume in USD

min_lifetime

integer

required

≥ 1

Minimum time of spread existence in milliseconds

max_lifetime

integer

required

≥ 1000

Maximum time of spread existence in milliseconds

hook

uri

required

length between 1 and 2083

Hook URL

buy_networks

array of strings

required

List of chains available to withdraw cryptocurrency on the exchange to buy asset

Buy Networks*

sell_networks

array of strings

required

List of chains available to deposit cryptocurrency on the exchange to sell asset

Sell Networks*

buy_networks_status

array of strings

required

Status of the possibility of withdrawal in selected chainson the exchange of buying an asset:

output_y - withdraw is open
output_n - withdraw is close

Buy Networks Status*

sell_networks_status

array of strings

required

Status of the possibility of deposit in selected chainson the exchange of selling an asset:

input_y - deposit is open
input_n - deposit is close

Sell Networks Status*

buy_exchanges

array of strings

required

List of exchanges for buying an asset

Buy Exchanges*

sell_exchanges

array of strings

required

List of exchanges for selling an asset

Sell Exchanges*

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://b2b.api.arbitragescanner.io/api/screener/v1/live/spot/spread-hook \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error