Getting Started

We work to try and make it as easy as possible for you to get started using the search engine, providing you with the following steps to follow.

1) Read Documentation

We provide separate interactive documentation for each of the APIs, but the search API is probably the one you are interested in using, unless you are a partner and have contacted us about the verified plan.

2) Generate GitHub Developer Token

To obtain a token, just head over to your [GitHub settings and generate a personal access token]( within minimal viable access to your GitHub profile--which we will then verify and add as API key for the API.

5) Try API With Your Token

The documentation for each API has a try it out function where you can put your API token in and begin making calls to the API. You will be able to make up to 500 calls per day using your token, and if you need more you can contact us about bumping up to the verified plan.

6) Download SDK of Your Choice

If you are needing to integrate the API into an application you can download one of our SDKs in the programming language of your choice. If there is a platform or language that is not available, make sure to let us know so we can see if you can make it happen.


Our goal is to get you started with the API, but also provide a simple example of a machine and human readable set of getting started steps that any other API producer can follow along with their APi.