DEV Community

Francis
Francis

Posted on

Getting Started With the Kelvin Data API

πŸ‘‰ Learn How to navigate over 1.8 billion people records by email, phone number, name, social media, and more in a single line of code with the Kelvin Data API

If you are new to the Kelvin Data API, then you've come to the right place!

Intro to Developer Resources

Introduction

This reference will get you started with working with the Kelvin Data API

If this is your first look at the Kelvin Data API, visit our HomePage for a quick Overview.

Conventions and Architecture

  • The base URL for sending API Requests is https://www.kelvindata.com

  • The Kelvin Data follows both RESTful and GraphQl Conventions and HTTPS is required for all API Requests.

  • API calls are performed with the GET request as we are extracting information from both page and database resources.

  • Request and Response bodies are encoded in JSON format

Code Samples & SDKs

  • Sample requests and responses are shown for each endpoint as illustrated below: Response
  • Requests are shown using the Kelvin data cURL as shown below:These make it easy to copy,paste,modify as you work with the API.
  curl --request GET \
     --url https://api.kelvindata.com/rest/v1/search-v2 \
     --header 'Accept: application/json'
Enter fullscreen mode Exit fullscreen mode
  • You may also choose any language or library of your preference that allows you to make HTTP requests.

Authentication

  • All API requests/calls with the Kelvin data API require an API Key for Authentication.
  • You can create and manage your API Keys on your developer page on the Kelvin data dashboard.
  • Authentication is in both the REST & GraphQl architectural patterns though slightly different. take a look below!
REST API Authentication:
  • Include a URL query parameter apiKey as shown:
https://api.kelvindata.com/rest/v1/search-v2?phone=4158675309&apiKey=your-apikey-here
Enter fullscreen mode Exit fullscreen mode
GRAPHQL Authentication:
  • Set the Authorization header to Bearer your-apikey-here as illustrated below:
{"Authorization": "Bearer your-apikey-here"}

curl 'https://api.kelvindata.com/graphql' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your-apikey-here' \
--data-binary '
{"query":"query exampleQuery { searchV2(phone: \"7043628945\") { emailAddresses name { first last } } }"}
'
Enter fullscreen mode Exit fullscreen mode

Conclusion

I am just getting your feet wet in this blog post. Check out our Kelvin data docs for more capabilities

Get in Touch

  • Want to get in Touch? We'd love to hear from you! Send us a message or inquiry Hello@KelvinData.com

Discussion (0)