Whale alert

Subscribe firebase

This endpoint allows you to subscribe for whale alerts using firebase.

Chains Supported:

Mainnet: Ethereum, BSC, Matic, Celo, Avalanche, Xinfin, Klaytn, Kadena, Velas, Cronos, Fuse, Solana, Fantom, Arbitrum.

Testnet: bsc-testnet, klaytn-testnet and polygon-testnet(mumbai-testnet)

In order to use notifications for testnets use

  https://testnet-notify.unmarshal.com/v1/firebase/whale-alert/subscribe    

along with all required body.

unmarshal.Notifications
   .Firebase.SubscribeWhaleAlert({
       deviceId: "deviceId",
       fcmToken: "deviceFcmToken",
       type: "USDValueBasedAlert | VolumeBasedAlert",
       threshold: 1000,
       tokenAddresses: ["demo.eth"],
   }).then(({data}) => console.log(data))
Request
Security:
query Parameters
chain
string

filter notifications based on given chain

Request Body schema: application/json
fcm_token
required
string
device_id
required
string
token_addresses
required
Array of strings
type
required
string
Threshold
required
integer <int32>
Responses
200
post/firebase/whale-alert/subscribe
Request samples
application/json
{
  • "fcm_token": "REPLACE_WITH_YOUR_FCM_TOKEN",
  • "device_id": "REPLACE_WITH_YOUR_DEVICE_ID",
  • "token_addresses": [
    ],
  • "type": "USDValueBasedAlert",
  • "Threshold": 10000
}

Subscribe webhook

This endpoint allows you to subscribe for whale alerts using webhook.

Chains Supported:

Mainnet: Ethereum, BSC, Matic, Celo, Avalanche, Xinfin, Klaytn, Kadena, Velas, Cronos, Fuse, Solana, Fantom, Arbitrum.

Testnet: bsc-testnet, klaytn-testnet and polygon-testnet(mumbai-testnet)

In order to use notifications for testnets use

  https://testnet-notify.unmarshal.com/v1/webhook/whale-alert/subscribe    

along with all required body.

unmarshal.Notifications
   .Webhook.SubscribeWhaleAlert({
       webhookUrl: "http://localhost:8080",
       tokenAddresses: ["demo.eth"],
       type: "USDValueBasedAlert | VolumeBasedAlert",
       threshold: 1000,
   }).then(({data}) => console.log(data))
Request
Security:
query Parameters
chain
string

filter notifications based on given chain

Request Body schema: application/json
webhook_url
required
string
token_addresses
required
Array of strings
type
required
string
Threshold
required
integer <int32>
Responses
200
post/webhook/whale-alert/subscribe
Request samples
application/json
{}