Skip to main content
GET
/
balance-monitors
List balance monitors
curl --request GET \
  --url http://localhost:5001/balance-monitors \
  --header 'X-blnk-key: <api-key>'
import requests

url = "http://localhost:5001/balance-monitors"

headers = {"X-blnk-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-blnk-key': '<api-key>'}};

fetch('http://localhost:5001/balance-monitors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "5001",
CURLOPT_URL => "http://localhost:5001/balance-monitors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-blnk-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "http://localhost:5001/balance-monitors"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-blnk-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:5001/balance-monitors")
.header("X-blnk-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:5001/balance-monitors")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-blnk-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
Use blnk.balance_monitor.list to retrieve all balance monitors.
1

Call the method

blnk.balance_monitor.list
response = blnk.balance_monitor.list()
This method takes no arguments.
2

Use the monitor list

Iterate over response.data to find monitors by balance_id or monitor_id. Save IDs you need for updates or lookups.
3

Response

200 OK
[
  {
    "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
    "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "condition": {
      "field": "credit_balance",
      "operator": ">",
      "value": 1000,
      "precision": 100
    },
    "call_back_url": "https://api.example.com/balance-monitor",
    "description": "Low balance alert",
    "created_at": "2024-02-20T05:56:58.257315054Z"
  }
]
FieldTypeDescription
response.datalist[dict]Array of balance monitor objects.

Balance monitoring

Conditions and webhook behavior.

View balance monitor details

HTTP request and response schema.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.