Skip to main content
POST
/
v1
/
search
/
keyword
/
urls
List individual URLs matching keywords
curl --request POST \
  --url https://api.vantaprism.me/v1/search/keyword/urls \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "keywords": [
    "admin-panel"
  ],
  "limit": 50
}
'
{
  "data": [
    {
      "url": "<string>",
      "domain": "<string>",
      "title": "<string>",
      "occurrence": 123,
      "last_seen": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "request_id": "req_01HZXK3Q7N8YV6F3M2P9JABCDE",
    "took_ms": 42.7,
    "tier": "pro",
    "masked_fields": [
      "password",
      "ip"
    ],
    "freshness_at": "2023-11-07T05:31:56Z"
  },
  "nextCursor": "<string>"
}

Authorizations

api-key
string
header
required

Static API key, format vp_<env>_<8-hex-prefix>.<40-hex-secret>. Preferred header for server-to-server integrations.

Body

application/json
keywords
string[]
required
Required array length: 1 - 10 elements
start_date
string<date-time> | null
end_date
string<date-time> | null
sort_direction
enum<string>
default:desc

Sort order applied to inserted_at. Must stay constant across paginated requests using the same cursor.

Available options:
asc,
desc
cursor
string | null
limit
integer
default:50
Required range: 1 <= x <= 500

Response

Matching URLs

data
object[]
required
meta
object
required

Metadata attached to every successful response.

nextCursor
string | null