Skip to main content

API reference

Every endpoint of the v2 API, grouped by area. Each page lists the parameters and response fields, shows code samples, and can send read requests with your API key. Requests from the page go to https://api.urlquery.net and consume your quota. Deleting a report is not possible from the page; use your own client.

Start with the API overview for authentication, errors, pagination, and rate limits. To generate a client or import the API into a tool, download the OpenAPI description.

Submissions

  • POST
    Submit a URL/submissions

    Queues a URL for analysis in an isolated browser.

  • GET
    Get a submission/submissions/{queue_id}

    Returns the progress of a submission made by you or your team.

Reports

  • GET
    Get a report/reports/{report_id}

    Returns the full report document: the overview fields plus HTTP transactions, JavaScript, detections, and extracted artifacts.

  • DELETE
    Delete a report/reports/{report_id}

    Deletes a report submitted by the caller's account.

  • GET
    Get a report overview/reports/{report_id}/overview

    Returns the compact overview of a report.

  • GET
    Get a report screenshot/reports/{report_id}/screenshot

    Returns the screenshot captured during the analysis.

  • GET
    Download a captured resource/reports/{report_id}/resources/{hash}/content

    Returns the content of a resource captured in the report, always as an application/octet-stream attachment so browsers do not render it.

  • GET
    List recent reports/reports/recent

    Lists recent reports visible to the caller, newest first.

  • GET
    List related reports/reports/related

    Lists recent reports whose target (the IP address, ASN, or domain of the analyzed URL) matches value, newest first.

  • GET
    Search reports/reports/search

    Searches reports from the last year.

Reputation

  • POST
    Look up URL reputation/reputation/lookup

    Evaluates exact URL and FQDN reputation over the last 30 days and returns the stronger verdict.

  • GET
    Export reputation indicators/reputation/export

    Streams indicators with urlquery evidence as NDJSON: a kind=meta line, then kind=indicator lines, then a matching kind=complete line with the export ID, count, and SHA-256 digest.

Host Profile

  • GET
    List hosts sharing a fact/hosts

    Pivots from one observed fact to the hosts that have it.

  • GET
    Search host cohorts/hosts/search

    Finds hosts by observation time and incoming or outgoing relation metrics.

  • GET
    Get a host profile/hosts/{host}

    Returns an observed FQDN or IP with its IPs, technologies, certificates, value-free cookie fingerprints, response-header names, MIME types, and relation totals.

  • GET
    List a host's relations/hosts/{host}/relations

    Lists directional relations of a host.

  • GET
    List relations/hosts/relations

    Lists directional relations across all hosts.

Detection