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"]
}'
{
"success": true,
"message": "Successfully fetched relay information.",
"data": [
{
"contact": "jb55@jb55.com",
"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
/
api
/
v1
/
utils
/
relay-info
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"]
}'
{
"success": true,
"message": "Successfully fetched relay information.",
"data": [
{
"contact": "jb55@jb55.com",
"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
array
The array of relay URLs you wish to get information from.
Response
boolean
Indicates whether the call was successful.
true if successful, false if not.string
Message detailing the results of the operation.
object
The contents of the data response object.
Show Toggle
Show Toggle
string
Email address for the operator of the relay.
string
Description of the use of this relay.
string
The name of the given relay.
string
The Nostr public key of the relay.
string
The specific Nostr implementation used by this relay.
array
The individual NIPs supported by this relay.
string
The specific version of the Nostr implementation used by this relay.
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"]
}'
{
"success": true,
"message": "Successfully fetched relay information.",
"data": [
{
"contact": "jb55@jb55.com",
"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"
}
]
}