Getting Started

Every SimilarTech user is eligible for certain amount of monthly API credit, determined by the user's plan. Even non-paying users and users with non-API subscription plans are eligible for 10 monthly API credits, to experiment using our APIs.

Step 1: Creating your SimilarTech Account

In order to get started making APIs requests, first make sure you have created a SimilarTech user account.

Step 2: Getting your API Key

Your monthly API credits usage and availability is placed in the account page in your user dashboard.

The API key parameter is a user-specific identification key that we use for counting your credits usage. Your personal API key can be found in your user dashboard. It must be provided for all API calls.

Available APIs

Website Technologies Profiling

Returns a list of technologies found on a requested website domain and their categories.

Cost per successful call: 1 credit.

Request
GET
https://api.similartech.com/v1/site/{Domain}/technologies?userkey={ApiKey}&format={Format}
Parameter Type Description
Domain String The website domain for profiling
ApiKey String API key
Format String Optional. Response data format ("json" / "xml"). Default: "json".
Example Request
$ curl -i "https://api.similartech.com/v1/site/yahoo.com/technologies?userkey=0123456789abcdef&format=json"
Response

JSON / XML serialized list of technologies, where technology consists of the following fields:

Parameter Type Description
Id Int The technology Id
Name String The technology name
Categories String Array The technology categories
Coverage float The coverage of the technology on the website
Paying String ['yes','no','maybe'] Does the technology costs money
Example Response
HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Type: application/json; charset=utf-8 Expires: -1 X-RateLimit-Limit: 25000 X-RateLimit-Remaining: 24989 Date: Fri, 20 Feb 2015 12:00:00 GMT Content-Length: 1934

Website Technologies Pages Profiling

Returns a list of technologies found on a requested website domain, their categories and the pages for each technology.

Cost per successful call for all technologies: 5 credits.

Cost per successful call for specific technology: 1 credit.

Request
GET
https://api.similartech.com/v1/site/{Domain}/technologies/all/pages?userkey={ApiKey}&format={Format}
Parameter Type Description
Domain String The website domain for profiling
ApiKey String API key
Format String Optional. Response data format ("json" / "xml"). Default: "json".
 
GET
https://api.similartech.com/v1/site/{Domain}/technologies/pages?userkey={ApiKey}&techid={TechID}&format={Format}
Parameter Type Description
Domain String The website domain for profiling
ApiKey String API key
TechID Int The technology Id based on SimilarTech Database
Format String Optional. Response data format ("json" / "xml"). Default: "json".
Example Requests
$ curl -i "https://api.similartech.com/v1/site/jet.com/technologies/all/pages?userkey=0123456789abcdef&format=json"
 
$ curl -i "https://api.similartech.com/v1/site/jet.com/technologies/pages?userkey=0123456789abcdef&techid=1779&format=json"
Response

JSON / XML serialized list of technologies, where technology consists of the following fields:

Parameter Type Description
Id Int The technology Id
Name String The technology name
Categories String Array The technology categories
Coverage float The coverage of the technology on the website
Paying String ['yes','no','maybe'] Does the technology costs money
Pages String Array The pages where the technology was detected
Example Response
HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Type: application/json; charset=utf-8 Expires: -1 X-RateLimit-Limit: 25000 X-RateLimit-Remaining: 24976 Date: Fri, 2 Jun 2017 12:00:00 GMT Content-Length: 187

Website Company Profiling

Returns company information for a requested website domain.

Cost per successful call: 5 credits.

Request
GET
https://api.similartech.com/v1/site/{Domain}/company?userkey={ApiKey}&format={Format}
Parameter Type Description
Domain String The website domain for profiling
ApiKey String API key
Format String Optional. Response data format ("json" / "xml"). Default: "json".
Example Request
$ curl -i "https://api.similartech.com/v1/site/yahoo.com/company?userkey=0123456789abcdef&format=json"
Response

JSON / XML serialized company information based on website where company consists of the following fields:

Parameter Type Description
Name String Company name
Description String Company description
YearFounded Int The year the company was founded
Homepage String Company homepage url
Favicon String Company icon url
Logo String Company logo url
Rankings List [{"name": String, "year": Int }] Company rankings
Address String Company address
Location String Company full address
Country String Company country
State String Company state
City String Company city
Zip String Company zip
Phone String Company phone
Fax String Company fax
EmployeeRange String Company employee range
LinkedInUrl String Company LinkedIn url
FacebookUrl String Company Facebook url
Twitter Url String Company Twitter url
FacebookLikes Int Company Likes on facebook
TwitterFollowers Int Company Twitter followers
LinkedInId Int Company LinkedIn ID
Example Response
HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Type: application/json; charset=utf-8 Expires: -1 X-RateLimit-Limit: 25000 X-RateLimit-Remaining: 24976 Date: Fri, 2 Jun 2017 12:00:00 GMT Content-Length: 1731

Response headers

Each API response includes the following HTTP headers:

Key Description
X-RateLimit-Limit The amount of your total monthly API credits allowed in your current plan
X-RateLimit-Remaining The amount of your remaining monthly API credits

Didn't find the API you were looking for?

More APIs are in the works!