Skip to content

Developers

API Documentation

Public reference for the PrimeHits Search ULP API — the same backend as the website and Telegram bot. Sign in to generate a key and try the playground.

Access

API access is included on Monthly and 4 Months memberships, or available as a standalone API plan.

  • Monthly: 200 requests / day
  • 4 Months: 1000 requests / day (higher priority)

Authentication

Send your personal Bearer key on every request:

Authorization: Bearer ph_live_…

POST /api/v1/search

Start a Search ULP job against an archive file.

{
  "folder": "Logs",
  "file": "archive.txt",
  "query": "netflix.com",
  "case_sensitive": false
}

Response includes a job id and poll_url.

GET /api/v1/search/:id

Poll job status. Fields: status, progress, matchCount, linesScanned, truncated, error.

Error codes

  • 401 — missing / invalid API key
  • 403 — plan without API access
  • 422 — invalid body
  • 429 — rate / daily limit
  • 503 — maintenance / Search ULP offline

Ready to build?

Activate a membership with crypto to generate your API key.

Get startedAPI overview