Lead lists

Find prospects by the technologies they use. Lead lists contain websites, company and contact details, social media profiles and more. Create and export custom reports for any web technology or keyword based on industry, website traffic and location.

List all lists

Returns an array of your lead lists.

Endpoint

GET https://api.wappalyzer.com/v2/lists/

Properties

Property Description
Execution Synchronous
Request timeout 20 seconds
Rate limit 5 requests per second
Pricing Free

Response body

Name Description
id

The list's unique identifier.

createdAt

List creation date as a UNIX timestamp.

status

List status. One of Calculating, Ready, Failed, Insufficient or Complete.

totalCredits

The price of the list in credits.

technologies

Array of technologies.

keywords

Array of keywords.

rows

The total number of results in the list per technology.

Example

Request

curl -H "x-api-key: <your api key>" "https://api.wappalyzer.com/v2/lists/"

Response

[ { "id": "lst_abcdef", "createdAt": 1620687647, "status": "Ready", "totalCredits": 1000, "technologies": [ { "slug": "shopify", "name": "Shopify", "categories": [ { "slug": "ecommerce", "name": "Ecommerce" } ], "operator": "=", "version": null }, ], "keywords": [], "rows": 1000 } ]

Fetch a list

Returns the full details of a list by its ID.

Endpoint

GET https://api.wappalyzer.com/v2/lists/{id}

Properties

Property Description
Execution Synchronous
Request timeout 20 seconds
Rate limit 5 requests per second
Pricing Free

Path parameters

Parameter Description
id The list's unique identifier, e.g. lst_abcdef.

Response body

Name Description
id

The list's unique identifier, e.g. lst_abcdef.

createdAt

List creation date as a UNIX timestamp.

status

List status. One of Calculating, Ready, Failed, Insufficient or Complete.

technologies

Array of technologies.

keywords

Array of keywords.

languages

Array of language codes (ISO 639-1), e.g. en-us.

countries

Array of two-letter country codes (ISO 3166-2), e.g. US.

industries

Array of industries, e.g. Fashion & Apparel.

companySizes

Array of company sizes, e.g. 1,001-5,000 employees

tlds

Array of top-level domains, e.g. .com.

matchCountryLanguage

Filtering by both country and language (true) or either (false).

matchTechnologies

Operator for the technology filter, one of or, and or not.

subset

Limits the number of results in the list per technology. Use subsetSlice to target higher or lesser trafficked websites.

subsetSlice

Websites in the list are sorted in order of traffic. When a subset is specified, subsetSlice determines which section of the list the results should be taken from (i.e. top or bottom). Set to 0-4 for highest, high, medium, low and lowest traffic, respectively. Default is 0 for highest traffic.

This option has no effect when subset is equal to or larger than the total number of available results.

minAge

Include results that were verified at least minAge months ago (0-11, default is 0).

maxAge

Include results that were verified at most maxAge months ago (1-12, default 3).

fromDate

Only include websites that were discovered after a date (UNIX timestamp).

requiredSets

Array of required field sets, see Fields.

excludeNoTraffic

Exclude websites that don't include traffic data.

excludeMultilingual

Exclude websites with content in more than one language.

sets

Array of field sets to include in the results.

callbackUrl

Callback URL that's notified when the list is ready.

totalCredits

The price of the list in credits.

url

URL of a ZIP file with the list.

sampleUrl

URL of a ZIP file with a sample taken from the list.

rows

Number of results in the list per technology.

setRows

Number of values included in the list per field set.

Example

Request

curl -H "x-api-key: <your api key>" "https://api.wappalyzer.com/v2/lists/lst_abcdef"

Response

{ "id": "lst_abcdef", "createdAt": 1620687647, "status": "Ready", "technologies": [ { "slug": "shopify", "name": "Shopify", "categories": [ { "slug": "ecommerce", "name": "Ecommerce" } ], "operator": "=", "version": null }, ], "keywords": [ "FASHION" ], "languages": [ "en-us" ], "countries": [ "US" ], "industries": [ "Fashion & Apparel" ], "companySizes": [ "1,001-5,000 employees" ], "tlds": [ ".com" ], "matchCountryLanguage": false, "matchTechnologies": "or", "subset": 1000, "subsetSlice": 0, "minAge": 0, "maxAge": 3, "fromDate": null, "requiredSets": [ "email" ], "excludeNoTraffic": false, "excludeMultilingual": false, "sets": [ "email", ], "callbackUrl": "https://yourdomain/wappalyzer", "totalCredits": 1000, "url": null, "sampleUrl": "https://lists.wappalyzer.com/wappalyzer-29ddddaa-4949-4217-86a7-f6a407e5853d-lst_abcdef-5ukjhs-sample.zip", "rows": { "shopify": 1000 }, "setRows": { "email": 1000, } }

Create a list

Endpoint

POST https://api.wappalyzer.com/v2/lists

Properties

Property Description
Execution Asynchronous
Request timeout 20 seconds
Rate limit 5 requests per second
50 requests per day
10 concurrent requests (lists with Calculating status)
Pricing Free

Request body

Name Description
technologies

Array of technologies to filter by.

Name Description
slug (required)

Technology slug, e.g. hubspot-chat. Refer to the full list of technologies (JSON).

version

Optional version number to target, e.g. 1.0.0.

operator

Version number operator, one of = (exact match), >= (great than or equal to) or <= (lower than or equal to).

keywords

Array of keywords to filter by, e.g. fashion. Keywords must be alphanumeric (a-z0-9) and work best with English nouns. Prefix with not  to exclude, e.g. not fashion.

languages

Array of language codes (ISO 639-1) to filter, e.g. en-us.

countries

Array of two-letter country codes (ISO 3166-2) to filter, e.g. US.

industries

Array of industries, e.g. Fashion & Apparel.

companySizes

Array of company sizes to filter, e.g. 5000 for 1,001-5,000 employees.

tlds

Array of top-level domains to filter, e.g. .com.

matchCountryLanguage

Filter by both country and language (true) or either (false).

matchTechnologies

Operator for the technology filter, one of or (match any), and (match all) or not (match the first technology, exclude all others).

subset

Limit the number of results in the list per technology. Use subsetSlice to target high or low traffic websites.

subsetSlice

Websites in the list are sorted in order of traffic. When a subset is specified, subsetSlice determines which section of the list the results should be taken from (i.e. top or bottom). Set to 0-4 for highest, high, medium, low and lowest traffic, respectively. Default is 0 for highest traffic.

This option has no effect when subset is equal to or larger than the total number of available results.

minAge

Include results that were verified at least minAge months ago (0-11, default is 0).

maxAge

Include results that were verified at most maxAge months ago (1-12, default is 3).

fromDate

Only include websites that were discovered after a date (UNIX timestamp, e.g. 1620687647).

requiredSets

Array of required field sets, e.g. email. See Fields.

excludeNoTraffic

Exclude websites that don't include traffic data (true or false (default)).

excludeMultilingual

Exclude websites with content in more than one language (true or false (default)).

sets

Array of field sets to include in the results, e.g. email. See Fields.

callbackUrl

Callback URL that's notified when the list is ready, e.g. https://yourdomain.com/wappalyzer.

Response body

Name Description
id

The list's unique identifier.

status

List status. One of Calculating, Ready, Failed, Insufficient or Complete.

totalCredits

The price of the list in credits.

sampleUrl

URL of a ZIP file with a sample taken from the list.

rows

Number of results in the list per technology.

setRows

Number of values included in the list per field set.

Callback response

A callback URL is a public endpoint hosted on your own server. Creating a list can take anywhere from a few seconds to a couple of hours depending on the technology and complexity of the query. Instead of periodically checking if a list is ready, use a callback URL to be notified immediately.

Example

Request

curl -X POST -H "Content-Type: application/json" -H "x-api-key: <your api key>" "https://api.wappalyzer.com/v2/lists/lst_abcdef" -d '{ "technologies": [ { "slug": "shopify" } ] }'

Response

{ "id": "lst_abcdef", "status": "Calculating" }

Callback response

Your callback URL will receive a POST request when the list is ready.

{ "id": "lst_abcdef", "status": "Ready", "rows": 1000, "setRows": [ "email": 1000 ], "totalCredits": 1000, "sampleUrl": "https://lists.wappalyzer.com/wappalyzer-29ddddaa-4949-4217-86a7-f6a407e5853d-lst_abcdef-5ukjhs-sample.zip" }

Finalise a list

When a list is ready, it must be finalised before you can download the results. Finalising involves making a payment using your credit balance, after which the list status changes to Complete.

Endpoint

POST https://api.wappalyzer.com/v2/lists/{id}

Properties

Property Description
Execution Synchronous
Request timeout 20 seconds
Rate limit 5 requests per second
Pricing 1 Credit per website

Path parameters

Parameter Description
id The list's unique identifier, e.g. lst_abcdef.

Request body

Name Description
spendCredits

The number of credits to spend. This value must exactly match the list's totalCredits, obtained from either the callback response or fetch endpoint.

Example

Request

curl -X POST -H "Content-Type: application/json" -H "x-api-key: <your api key>" "https://api.wappalyzer.com/v2/lists/lst_abcdef" -d '{ "spendCredits": 1000 }'

Response

{ "id": "lst_abcdef", "status": "Complete", "url": "https://lists.wappalyzer.com/wappalyzer-29ddddaa-4949-4217-86a7-f6a407e5853d-lst_abcdef-5ukjhs.zip", }

Delete a list

Permanently delete a list.

Endpoint

DELETE https://api.wappalyzer.com/v2/lists/{id}

Properties

Property Description
Execution Synchronous
Request timeout 20 seconds
Rate limit 5 requests per second
Pricing Free

Path parameters

Parameter Description
id The list's unique identifier, e.g. lst_abcdef.

Example

Request

curl -X DELETE -H "x-api-key: <your api key>" "https://api.wappalyzer.com/v2/lists/lst_abcdef"

Response

{}

Subscribe to receive occasional product updates.