Search apps
curl --request GET \
--url https://api.periphery.exposed/v1/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.periphery.exposed/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.periphery.exposed/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"total": 2,
"page": 1,
"hits": [
{
"hostname": "acme-dashboard.vercel.app",
"title": "Acme dashboard",
"status": 200,
"provider": "vercel",
"faviconHash": -247388890,
"emails": [
"ops@acme.com"
],
"hasCreds": true
},
{
"hostname": "acme-com-staging.vercel.app",
"title": "Acme (staging)",
"status": 401,
"provider": "vercel",
"hasCreds": false
}
]
}Endpoints
Search apps
Runs a query in the console’s syntax and returns one page of 50 hits.
Free text, bare domains, and key:value filters work exactly as in
the search bar; see the filter reference in the guides.
Searches are unlimited; only the per-second rate limit applies. An
empty q returns an empty page. has:creds always applies, since API
access and the filter are both Plus and Pro features.
GET
/
v1
/
search
Search apps
curl --request GET \
--url https://api.periphery.exposed/v1/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.periphery.exposed/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.periphery.exposed/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"total": 2,
"page": 1,
"hits": [
{
"hostname": "acme-dashboard.vercel.app",
"title": "Acme dashboard",
"status": 200,
"provider": "vercel",
"faviconHash": -247388890,
"emails": [
"ops@acme.com"
],
"hasCreds": true
},
{
"hostname": "acme-com-staging.vercel.app",
"title": "Acme (staging)",
"status": 401,
"provider": "vercel",
"hasCreds": false
}
]
}Authorizations
bearerAuthapiKeyHeader
Authorization: Bearer <key>. Used when both headers are present.
Query Parameters
The query, in the console's search syntax.
Page number, starting at 1. Each page holds 50 hits. A page past the end returns an empty hits array. Values below 1 or that are not numbers are treated as 1.
Required range:
x >= 1