Social Crawlytics Documentation

About our API

Our API was designed to be simple and easy to get started with. We try to accommodate the most used methods, though if there's something you feel should be added, please let us know!

Our API is stateless, meaning there's no sessions or cookies to manage, you just need to supply your account token and key with each API request you make. You can find your API credentials by logging into Social Crawlytics and looking under the "Dashboard tab" for "API Credentials", or you can click here.

Available tools

To help get you get started with our API, we've made a couple of tools available.

Getting started

There are several ways you can make an API request, but in essence it involves making a GET or POST request to our server (other options such DELETE will be introduced later when we expand our command set). The base address for our API is, you will also need to supply your API token and key with each request, which can either be done via the GET, POST, or HTTP Auth headers. In our examples we'll use the GET parameters as it allows copy-pasting for easier examples.

The easiest example would be to obtain your credit count, the resource address for doing this is account/credits, so combined with our token and key, we can visit and see how many credits we have remaining. It should also be noted that you can append either .json or .xml onto the end of the resource to change the output format such as

Understanding results

Because we use this API system in other internal parts of our application, the structure might not be immediately obvious. When you get a result set, you get an object containing three children named _transactions, _partials, and _errors. Currently our public API does not make use of partial responses, so we'll address transactions and errors. Inside each of those children can be many objects, each with the format of mark, source, results, and dataset. Mark is the name of the API response, source is the resource that handled the API response, results is the number of results in dataset, and dataset is where the majority of our information will be held.

A structure like this means that a request can return multiple transaction results, multiple errors, or a mixture of both. For example, when you call resource that costs credits you will receive a transaction with your request, but also a transaction notifying you of your new credit count.

We've tried to make the data field names as helpful as possible, and a complete list of available API resources and their fields can be found on our interactive API page.

Discover your competitor's sticky content.

Sign up today, it is completely free.