Get Started
Experimental APIs
Healthcheck APIs
curl --location --request GET 'https://nostrapi.com/api/v1/account/stats?pubkey=andre@zbd.gg' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>'
{
"success": true,
"message": "Successfully fetched andre@zbd.gg pubkey profile stats",
"data": {
"pubkey": "1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d",
"stats": {
"followers": 2,
"following": 325,
"postCount": 618,
"repostCount": 266
},
"zaps": {
"totalMsatsSent": 986859000,
"totalCountSent": 65,
"maxMsatsSent": 500000000,
"minMsatsSent": 100000,
"totalMsatsReceived": 182229000,
"totalCountReceived": 292,
"maxMsatsReceived": 50000000,
"minMsatsReceived": 10000
}
}
}
Note APIs
Note Stats
Get general network stats about this Nostr account including follower count and Zaps
GET
/
api
/
v1
/
account
/
stats
curl --location --request GET 'https://nostrapi.com/api/v1/account/stats?pubkey=andre@zbd.gg' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>'
{
"success": true,
"message": "Successfully fetched andre@zbd.gg pubkey profile stats",
"data": {
"pubkey": "1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d",
"stats": {
"followers": 2,
"following": 325,
"postCount": 618,
"repostCount": 266
},
"zaps": {
"totalMsatsSent": 986859000,
"totalCountSent": 65,
"maxMsatsSent": 500000000,
"minMsatsSent": 100000,
"totalMsatsReceived": 182229000,
"totalCountReceived": 292,
"maxMsatsReceived": 50000000,
"minMsatsReceived": 10000
}
}
}
Query
The address of the Nostr account — can be a Nostr NIP05 address (e.g. andre@zbd.gg), or a Nostr public key in NPUB or HEX format.
Response
Indicates whether the call was successful.
true if successful, false if not.Message detailing the results of the operation.
The contents of the data response object.
Show Toggle
Show Toggle
The public key of the Nostr account in HEX format.
General statistics about this Nostr account.
General statistics about the Zapping activity around this Nostr account.
Show Toggle
Show Toggle
Total amount of Bitcoin Zapped BY this account (in millisatoshis).
Maximum Bitcoin amount Zapped BY this account at one time (in millisatoshis).
Minimum Bitcoin amount Zapped BY this account at one time (in millisatoshis).
Total amount of Bitcoin Zapped TO this account (in millisatoshis).
The number of Zaps this account has received.
Maximum Bitcoin amount Zapped TO this account at one time (in millisatoshis).
Minimum Bitcoin amount Zapped TO this account at one time (in millisatoshis).
curl --location --request GET 'https://nostrapi.com/api/v1/account/stats?pubkey=andre@zbd.gg' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>'
{
"success": true,
"message": "Successfully fetched andre@zbd.gg pubkey profile stats",
"data": {
"pubkey": "1b11ed41e815234599a52050a6a40c79bdd3bfa3d65e5d4a2c8d626698835d6d",
"stats": {
"followers": 2,
"following": 325,
"postCount": 618,
"repostCount": 266
},
"zaps": {
"totalMsatsSent": 986859000,
"totalCountSent": 65,
"maxMsatsSent": 500000000,
"minMsatsSent": 100000,
"totalMsatsReceived": 182229000,
"totalCountReceived": 292,
"maxMsatsReceived": 50000000,
"minMsatsReceived": 10000
}
}
}
⌘I