API integration
Sonar API allows you to retrieve data directly from Sonar database. The API currently provides two end points that return infographics, technographics as well as extra data for:
Domains
Emails
You need to retrieve the API key of your organisation to make calls with the API. The key can be found on the integrations page of your account.
Enrichment methods
Enrich a domain
GET
https://api-public.purplesonar.com/api/v1/enrich/domain/:domain
This endpoint returns infographic data for any domain you input.
Path Parameters
Query Parameters
Headers
Enrich an email
GET
https://api-public.purplesonar.com/api/v1/enrich/email/:email
Similarly to the domain endpoint, you can enrich an email to get the associated company's infographics and technographic
Path Parameters
Query Parameters
Headers
Lookup methods
Lookup technologies for a domain
GET
https://api-public.purplesonar.com/api/v1/domains/:domain/technologies
This endpoint returns all current and past technologies for a given domain. The first_seen_at parameter is returning null when the first detection does not result from a signal. This could happen when we add a technology and scan a website against that technology for the first time, or when a page was previously hidden behind a paywall so that we couldn't scan it in the past.
Path Parameters
Headers
Extra fields
For the enrichment endpoints, we return extra optional fields on demand if the extra_fields
parameter exists in the url.
We only return the extra pricing field for now. For example, if you add the pricing extra_field below:
Sonar will append the returned response with a pricing object as follow:
Note that every key in the pricing object can be null (like 'subscription').
New keys might also be added overtime.
Last updated