API Reference
Go to Nodit!

BELOW_THRESHOLD_BALANCE

지정된 계정의 잔고가 사용자가 설정한 특정 수치 이하로 떨어질 경우 알림을 제공합니다. 이 이벤트는 특히 재정 관리와 자산 보호에 중요한 역할을 합니다. 사용자는 이 기능을 통해 자신의 계정이 최소 잔고 아래로 떨어지지 않도록 예방 조치를 취할 수 있으며, 필요한 경우 적시에 추가 자금을 이체하거나 다른 금융 조치를 취할 수 있습니다.

Supported Network

NetworkSupporting
Ethereum Mainnet✅
Ethereum Testnet (sepolia)✅
Ethereum Testnet (holesky)✅
Polygon Mainnet✅
Polygon Testnet (amoy)✅
Arbitrum Mainnet✅
Arbitrum Testnet (sepolia)✅
Optimism Mainnet✅
Optimism Testnet (sepolia)✅
Kaia Mainnet✅
Kaia Testnet (kairos)✅
Aptos Mainnet❌
Aptos Testnet❌

Webhook 생성 요청 예제

eventType값을 BELOW_THRESHOLD_BALANCE로 설정하는 경우, 사용 가능한 condition 객체 필드는 아래와 같습니다.

KeyTypeRequiredDescriptionExample Value
addressStringtrue잔고 알림을 받고자 하는 대상 주소"0x3DC16F9F7fD2F5a17A9602650880255f01edC733"
belowThresholdBalanceStringtrue모니터링 하고자 하는 잔고의 임계값. 잔고가 설정한 임계값 밑으로 떨어지는 경우, 알림을 받을 수 있습니다."100000000000000000"

📘

알림의 주기는 어떻게 되나요?

1분 마다 해당 주소의 잔고를 조회하며 입력한 THRESHOLD 보다 잔고가 낮을 경우, 알림을 전송합니다. 만약 조회 시점마다 실제 잔고가 belowThresholdBalance에 입력한 값보다 낮은 경우, 알림을 계속해서 받을 수 있습니다.

Request Example

curl --location 'https://web3.nodit.io/v1/ethereum/mainnet/webhooks' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: ••••••' \
--data '{
  "eventType": "BELOW_THRESHOLD_BALANCE",
  "description": "{WEBHOOK_DESCRIPTION}",
  "notification": {
    "webhookUrl": "{WEBHOOK_LISTENER_ENDPOINT}"
  },
  "condition": {
    "address": 
        "0x3DC16F9F7fD2F5a17A9602650880255f01edC733",
    "belowThresholdBalance": "100000000000000000"
  }
}'

Response Example

{
  "subscriptionId": "4975",
  "description": "{WEBHOOK_DESCRIPTION}",
  "protocol": "ethereum",
  "network": "mainnet",
  "subscriptionType": "WEBHOOK",
  "notification": {
    "webhookUrl": "{WEBHOOK_LISTENER_ENDPOINT}"
  },
  "signingKey": "{signingKey}",
  "eventType": "BELOW_THRESHOLD_BALANCE",
  "event": {
    "message": {
      "type": "belowThresholdBalance",
      "address": "0x3DC16F9F7fD2F5a17A9602650880255f01edC733",
      "threshold": "100000000000000000",
      "balance": "2289407835113186"
    }
  },
  "createdAt": "2024-12-27T08:00:34.227Z"
}