Skip to main content
POST
security.host.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
query
string

Literal text to match; never a source-specific query language.

Required string length: 1 - 4096
filters
object

Structured filters; unsupported combinations are declined.

limit
integer
default:10

Maximum rows, 1 to 50; default 10.

Required range: 1 <= x <= 50
cursor
string

Opaque nextCursor from the same request; omit on the first page.

Required string length: 1 - 8192
includeBanners
boolean
default:false

Include inert banners and certificate subjects, possibly personal names.

Response

The result

results
object[]
required

Observed hosts or service documents, as countLevel identifies.

Maximum array length: 50
countLevel
enum<string>
required

Whether documents represent hosts or individual services.

Available options:
host,
service
total
integer

Document count, when reported.

Required range: 0 <= x <= 9007199254740991
totalRelation
enum<string>

Whether total is exact.

Available options:
exact,
at-least
nextCursor
string

Pass as cursor for more results; absent on the last page.

Maximum string length: 8192