Get Started
Experimental APIs
Healthcheck APIs
Copy
curl --location --request POST 'https://nostrapi.com/api/v1/utils/relay-info' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>' \
--data-raw '{
"relays": ["wss://nostr.zbd.gg", "wss://relay.damus.io"]
}'
Copy
{
"success": true,
"message": "Successfully fetched relay information.",
"data": [
{
"contact": "[email protected]",
"description": "Damus strfry relay",
"name": "damus.io ",
"pubkey": "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245",
"software": "git+https://github.com/hoytech/strfry.git",
"supported_nips": [
1,
9,
11,
12,
15,
16,
20,
22
],
"version": "v78-30b8c38"
},
{
"contact": "unset",
"description": "Notes and other stuff from ZEBEDEE users.",
"name": "ZBD Social",
"pubkey": "unset",
"software": "git+https://github.com/hoytech/strfry.git",
"supported_nips": [
1,
9,
11,
12,
15,
16,
20,
22
],
"version": "v126-fbbfc3a"
}
]
}
Utility APIs
Relay Information
Fetch public information about the provided Nostr relays
POST
https://nostrapi.com
/
api
/
v1
/
utils
/
relay-info
Copy
curl --location --request POST 'https://nostrapi.com/api/v1/utils/relay-info' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>' \
--data-raw '{
"relays": ["wss://nostr.zbd.gg", "wss://relay.damus.io"]
}'
Copy
{
"success": true,
"message": "Successfully fetched relay information.",
"data": [
{
"contact": "[email protected]",
"description": "Damus strfry relay",
"name": "damus.io ",
"pubkey": "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245",
"software": "git+https://github.com/hoytech/strfry.git",
"supported_nips": [
1,
9,
11,
12,
15,
16,
20,
22
],
"version": "v78-30b8c38"
},
{
"contact": "unset",
"description": "Notes and other stuff from ZEBEDEE users.",
"name": "ZBD Social",
"pubkey": "unset",
"software": "git+https://github.com/hoytech/strfry.git",
"supported_nips": [
1,
9,
11,
12,
15,
16,
20,
22
],
"version": "v126-fbbfc3a"
}
]
}
Body
The array of relay URLs you wish to get information from.
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
Email address for the operator of the relay.
Description of the use of this relay.
The name of the given relay.
The Nostr public key of the relay.
The specific Nostr implementation used by this relay.
The individual NIPs supported by this relay.
The specific version of the Nostr implementation used by this relay.
Copy
curl --location --request POST 'https://nostrapi.com/api/v1/utils/relay-info' \
--header 'Content-Type: application/json' \
--header 'apikey: <YOUR_KEY_HERE>' \
--data-raw '{
"relays": ["wss://nostr.zbd.gg", "wss://relay.damus.io"]
}'
Copy
{
"success": true,
"message": "Successfully fetched relay information.",
"data": [
{
"contact": "[email protected]",
"description": "Damus strfry relay",
"name": "damus.io ",
"pubkey": "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245",
"software": "git+https://github.com/hoytech/strfry.git",
"supported_nips": [
1,
9,
11,
12,
15,
16,
20,
22
],
"version": "v78-30b8c38"
},
{
"contact": "unset",
"description": "Notes and other stuff from ZEBEDEE users.",
"name": "ZBD Social",
"pubkey": "unset",
"software": "git+https://github.com/hoytech/strfry.git",
"supported_nips": [
1,
9,
11,
12,
15,
16,
20,
22
],
"version": "v126-fbbfc3a"
}
]
}
⌘I