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
get
https://api-public.purplesonar.com
/api/v1/enrich/domain/:domain
Enrich a domain
​
get
https://api-public.purplesonar.com
/api/v1/enrich/email/:email
Enrich an email
​
Extra fields
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:
1
https://api-public.purplesonar.com/api/v1/domains/:domain?extra_fields=pricing
Copied!
Sonar will append the returned response with a pricing object as follow:
1
"pricing": {
2
"pricing_page": "https://www.acme.com/pricing/",
3
"subscription": {
4
"has_trial": true,
5
"has_annual_plan": null,
6
"has_monthly_plan": true
7
}
8
}
Copied!
Note that every key in the pricing object can be null (like 'subscription').
New keys might also be added overtime.
Last modified 1yr ago
Copy link