GET Parameters

q

(Required) Specifies your search query. This parameter accepts a Boolean query, allowing you to define filters for the posts and messages returned by the API.

To find phishing-related posts associated with Amazon, use the following Boolean query: ("Phishing" AND "Amazon").

token

(Required) Your unique API authentication token, received when you signed up. This token verifies your access to the Webz.io API.

&token=[MY TOKEN]

sort

Determines the primary sorting criteria for the results.

Our possible options are:

• relevancy - Sorts by the number of matches to the query (most relevant first).
• crawled - Sorts by crawl date (oldest to newest).
• published - Sorts by the original publication date of posts (newest to oldest by default, or specify direction).
• updated - Sorts by the last update date of posts (oldest to newest).

Default: crawled. This is the recommended approach for clients to ensure comprehensive data retrieval when used with pagination.

&sort=crawled

order

Specifies the sorting order only for sort=published, either asc (ascending) or desc (descending, which is the default).

&sort=published&order=asc

ts

Returns results crawled after this Unix timestamp (in milliseconds). This parameter is useful for retrieving new or updated content.

Here is a Timestamp/Date converter

Default: Past 3 months.

&ts=1753779764000

format

Sets the desired output format for the response. It can be either:

• json
• xml

Default: JSON.

&format=xml

size

Limits the number of results returned per request. Allowed values: Between 1 and 10.

Default: 10

&size=5 (returns 5 results)

structured

When set to true, returns results with a more structured schema, often including additional parsed fields (author, site name, site type, site categories)

The default is all.

&structured=true

latest

When set to true, returns the latest 10 crawled posts matching your query.

Use of this feature is NOT recommended as it may result in loss of important results.

&latest=true

highlight

When set to true, return the fragments in the post that matched the textual Boolean query. The matched keywords will be surrounded by tags.

&highlight=true

warning

When set to true, includes API-related warnings in the response. These warnings may include issues like query parsing errors, and will contain a message, type, and level.

By default warnings are disabled.

&warning=true

is_updated

Returns posts that were updated at least once.

Use of this feature is NOT recommended as it may result in loss of important results.

&is_updated=true