WebTechSurvey API (1.0)

Download OpenAPI specification:Download

reports

List all reports

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

Response samples

200

Content type

application/json

["2215b47b-fe82-d987-27f0-4464fadee162",
"3215b47b-fe82-d987-27f0-4464fadee163"
]

Create report

Creates a report based on a search criteria

Request Body schema: application/json

required	Array of objects non-empty
CallbackURL	string <uri>
	object (CreateReportOptions)

Responses

Request samples

Payload

Content type

application/json

{"Criterias": [{"CriteriaElement": {"Include": true,
"Criteria": {"Technology": "string",
"Version": "string"
}
}
}
],
"CallbackURL": "http://example.com",
"Options": {"MaxDomainCount": 1
}
}

Response samples

201

Content type

application/json

{"id": "2215b47b-fe82-d987-27f0-4464fadee162"
}

Read report details

Provides access to report details

path Parameters

reportId

required

string <uuid>

Example: 2215b47b-fe82-d987-27f0-4464fadee162

The report identifier

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

Response samples

200

Content type

application/json

{"id": "2215b47b-fe82-d987-27f0-4464fadee162",
"status": "ready",
"priceInCredits": 2500,
"domainCount": 2500,
"reportURL": "https://webtechsurvey.com/reports/596cf349-ea24-534b-6445-1754dfc91fa5.zip"
}

Purchase report

Purchases the created report identified by the report ID.

path Parameters

reportId

required

string <uuid>

Example: 2215b47b-fe82-d987-27f0-4464fadee162

The report identifier

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Request Body schema: application/json

creditsToPay

integer

Number of credits to spend for the report.

Responses

Request samples

Payload

Content type

application/json

{"creditsToPay": 2500
}

Response samples

200

Content type

application/json

{"reportURL": "https://webtechsurvey.com/reports/596cf349-ea24-534b-6445-1754dfc91fa5.zip"
}

Delete report

This function deletes report identified by the Report ID.

path Parameters

reportId

required

string <uuid>

Example: 2215b47b-fe82-d987-27f0-4464fadee162

The report identifier

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

domain information

Retrieve domain data (preview|no-credits)

Returns partial data about the specified domain from the database. You can use this data to preview domain info before spending credits with method /domaininfo

query Parameters

domain

required

string

Example: domain=webtechsurvey.com

Domain name which data to be retrieved

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

Response samples

200

Content type

application/json

{"status": "success",
"creditsUsed": 0,
"remainingCreditsBalance": 10,
"results": {"crawlDate": "202024-04-01T07:00:00.000Z",
"technologyCount": 20,
"advertiserCount": 15,
"categoryCount": 5
}
}

Retrieves domain data

Retrieves data about the specified domain from the database

query Parameters

domain

required

string

Example: domain=webtechsurvey.com

Domain name which data to be retrieved

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

Response samples

200

Content type

application/json

{"status": "success",
"creditsUsed": 0,
"remainingCreditsBalance": 10,
"results": {"crawlDate": "202024-04-01T07:00:00.000Z",
"domainInfo": {"domain": "webtechsurvey.com",
"online": true,
"firstCrawledDate": "2024-03-01T08:00:00.000Z",
"lastCrawledDate": "2024-05-01T07:00:00.000Z",
"topLevelDomain": "com",
"rank": 5400,
"country": "US",
"ip": "34.96.66.233",
"language": "en",
"accessViaHTTP": false,
"httpOpen": true,
"httpsOpen": true,
"certIssuer": "DigiCert Inc",
"certExpiration"": "2024-09-17T07:00:00.000Z",
"asnId": 16550,
"asnName": "GOOGLE-PRIVATE-CLOUD",
"address": "123 Sesame Street, New York, NY, 10176, US",
"email": "[email protected]",
"phone": "+1.123.456.7890",
"twitter": "https://www.twitter.com/webtechsurvey",
"instagramm": "https://www.instagram.com/webtechsurvey",
"facebook": "https://www.facebook.com/webtechsurvey",
"youtube": "https://www.youtube.com/user/webtechsurvey",
"linkedin": "https://www.linkedin.com/company/webtechsurvey"
},
"technologies": [{"technology": "Cloudflare",
"version": "1.2",
"categories": ["CDN"
],
"usedSince": "2024-03-01T08:00:00.000Z",
"lastSeen": "2024-05-01T07:00:00.000Z"
}
],
"advertisers": [{"technology": "google.com Direct",
"usedSince": "2024-03-01T08:00:00.000Z",
"lastSeen": "2024-05-01T07:00:00.000Z"
}
],
"headers": [{"header": "Server",
"value": "nginx/1.24.0"
}
],
"keywords": [["Technology",
"Lead Generation",
"Website Profiling"
]
],
"tags": [["GM-12322456"
]
]
}
}

subdomains

Preview (free version) of /subdomains

Returns partial data about subdomains

query Parameters

domain

required

string

Example: domain=webtechsurvey.com

Domain name which data to be retrieved

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

Response samples

200

Content type

application/json

{"status": "success",
"creditsUsed": 0,
"remainingCreditsBalance": 10,
"results": {"subdomainCount": 3
}
}

Retrieve list of all subdomains

Returns list of all subdomains of the top-level-domain

query Parameters

domain

required

string

Example: domain=webtechsurvey.com

Domain name which data to be retrieved

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

Response samples

200

Content type

application/json

{"status": "success",
"creditsUsed": 1,
"remainingCreditsBalance": 10,
"results": {"subdomains": ["api.wikipedia.org",
"commons.wikipedia.org",
"en.wikipedia.org"
]
}
}

live scan

Scan website

Crawls and analyzes website

query Parameters

domain required	string Example: domain=webtechsurvey.com Domain to be crawled
cve	boolean Example: cve=true Specifies whether scan should test for CVE vulnerabilities (requires additional credits)

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

Response samples

200

Content type

application/json

{"status": "success",
"creditsUsed": 1,
"remainingCreditsBalance": 10,
"results": {"technologies": [{"technology": "Cloudflare",
"version": "1.2",
"categories": ["CDN"
],
"url": "https://webtechsurvey.com/"
}
],
"advertisers": [{"technology": "google.com Direct",
"url": "https://webtechsurvey.com/ads.txt"
}
]
}
}

misc

Check available balances

Return available credits and reports

header Parameters

x-api-key

required

string <uuid>

Example: wts-api-asn1k32j7klv51eyqz

Responses

Response samples

200

Content type

application/json

{"status": "success",
"creditsUsed": 0,
"remainingCreditsBalance": 10
}