Documentation / API / siteinfo_site
siteinfo_site
POSThttps://api.oppalerts.com/v1/siteinfo/site
Who owns one site and how to reach them: titles, meta tags, social accounts, email addresses, phone numbers, feeds, paths, and street addresses, merged from the stored page data.
What it does
The tool returns the stored record of one site. The record shows who owns the site and how to reach them: page titles, meta tags, social accounts, email addresses, phone numbers, feeds, paths, and street addresses. The record is merged from the stored page data. Each value includes the number of pages that contain it.
This tool has its own daily count. It does not use the index search
count of the news_ and prospects_ tools.
account_calls_left shows the
calls that are left today.
Authentication
Send your token in the Authorization: Bearer header. Authentication and Limits explains the tokens.
Parameters
sitestring, required, at most 255 characters- Bare domain, subdomain, or full URL. Only the host is kept. Asking for a domain returns the domain's own record; every other host under it is a key of hosts, with its own page count.
fullboolean, optional- true returns every member of every field, not only the first 1000. The answer can be very large. false or not sent: the first 1000 members.
Strict Rules
- A field that is not in the list above is refused. The answer is HTTP 400 with the error code
bad_param. The error names the field: "<field> is not a field of this tool." The old name of a renamed field is refused in the same way. - A bad value is refused, and the error names the field. A bad value is a value of the wrong type, a number with a fraction for a whole-number field, a value out of its range, or a value that is not in its list. A required field that you do not send is refused too. The tool never changes a value that you send.
- An error about the format of a call, such as a refused field, names the field. Its message ends with one sentence: "Read the documentation at https://oppalerts.com/docs for the correct format." Every other error has only its own sentence.
Response
The answer has these top-level fields:
querystring- The site as you sent it.
resolvedstring- The host that the lookup used.
foundbool- Whether a record exists for the site.
partialbool- A response flag. The source does not say when it is true.
truncatedobject- For each field that was cut to its first 1000 members, the full number of members. Send
fullas true to get every member. hostsobject- Each other host under the domain, with its page count.
recordobject- The merged data of the site. It is null when the site has no record.
The record object holds pages,
sponsored, titles, metas,
links, feeds, emails,
phones, locations, paths,
accounts, social, and rel_me. Most
fields map a value to the number of pages that carry it. For example,
emails maps each email address to a page count. Each entry of
locations has lat, lon,
street, city, region,
postal, country, and pages.
Example
Request
curl -X POST https://api.oppalerts.com/v1/siteinfo/site \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"site": "example-hotels.com"}'
Response
The full sample answer.
{
"query": "example-hotels.com",
"resolved": "example-hotels.com",
"found": true,
"partial": false,
"truncated": {
"emails": 1240
},
"hosts": {
"blog.example-hotels.com": 2140,
"careers.example-hotels.com": 310
},
"record": {
"pages": 12351,
"sponsored": 44,
"titles": {
"Example Hotels | Boutique Stays Worldwide": 9120,
"Book a Room | Example Hotels": 2210
},
"metas": {
"description": {
"Boutique hotels in 40 cities. Book direct for member rates.": 8630
},
"og:site_name": {
"Example Hotels": 11020
}
},
"links": {
"canonical": {
"https://example-hotels.com/": 8110
}
},
"feeds": {
"https://example-hotels.com/blog/feed": 210
},
"emails": {
"press@example-hotels.com": 34,
"reservations@example-hotels.com": 27
},
"phones": {
"+1-800-555-0134": 96
},
"locations": [
{
"lat": 40.7411,
"lon": -73.9897,
"street": "12 W 24th St",
"city": "New York",
"region": "NY",
"postal": "10010",
"country": "US",
"pages": 41
}
],
"paths": {
"about": {
"/about": 15,
"/about/leadership": 6
},
"contact": {
"/contact": 22
},
"partners": {
"/partners/travel-agents": 9
}
},
"accounts": {
"instagram@examplehotels": 1180,
"linkedin:business@example-hotels": 310
},
"social": {
"https://www.pinterest.com/examplehotels/boards": 12
},
"rel_me": {
"https://mastodon.social/@examplehotels": 3
}
}
}
Errors
bad_param(HTTP 400): a field is not a field of this tool, a required field is not sent, or a value has the wrong type or is out of its range. The error names the field.backend_error(HTTP 502): the data server did not answer, or its answer could not be read. Try again in a few minutes.daily_limit(HTTP 429): the account has used all its calls for this tool today. account_calls_left shows when the count resets.
A site with no stored data is not an error. The answer has found set to false and record set to null.
This tool has its own daily count. Calls through the API, MCP, and the web app use this count. It is not an index search, so it does not use the shared count of the news_ and prospects_ tools, and the error one_at_a_time does not apply to it.
Same tool in MCP
The MCP tool siteinfo_site gives the same data. See siteinfo_site in MCP.