Getting started

Welcome to the SE Ranking API! This guide will walk you through authenticating your account, making your first request, understanding our credit system, and more. Let’s get you up and running in minutes.

Authentication

All requests to the Data API must be authenticated. The base URL for all endpoints is:

https://api.seranking.com

1. Obtain your API key

First, you’ll need to generate a unique API key from your account dashboard.

1. Navigate to the API Dashboard. You can access this by clicking the API icon in the main left-hand navigation menu:

2. On the API Dashboard, click the + CREATE API KEY button located in the top-right corner:

3. In the Create API key dialog box:

a. Enter a descriptive name in the API key name field (e.g., “Demo”).

b. Under Type of API, select the Data option.

c. Click CREATE KEY.

4. Your new key will be generated and listed in the API Keys table. You can create multiple Data API keys for different applications or environments:

2. Authenticate your requests

You have two methods to authenticate your requests. We strongly recommend using the Authorization header.

Method 1: Authorization header (recommended)

Include an Authorization header in your request, with the value Token YOUR_API_KEY.

You can test your key by fetching your subscription details. The 200 OK response confirms that your key is working correctly.

curl -X GET 'https://api.seranking.com/v1/account/subscription' \

  -H 'Authorization: Token YOUR_API_KEY'

Method 2: Query parameter

Alternatively, you can pass the key as a URL query parameter named apikey.

curl -X GET 'https://api.seranking.com/v1/account/subscription?apikey=YOUR_API_KEY'

Making requests

Once authenticated, you can make requests to any API endpoint.

• GET requests can include parameters in the URL’s query string.
• POST requests must include the Content-Type: application/json header and send data in a JSON body.

Example POST request

Here is an example of a more complex POST request to the /backlinks/summary endpoint. Notice how the authentication header remains the same.

curl -X POST 'https://api.seranking.com/v1/backlinks/summary' \

  -H 'Authorization: Token YOUR_API_KEY' \

  -H 'Content-Type: application/json' \

  -d '{

    "target": "seranking.com",

    "mode": "host"

  }'

Postman collection

We offer a Postman collection to help you get started without writing any code. Postman is a free application that makes it easy to explore and test APIs.

Prerequisites

• Postman
• SE ranking account

Getting started

To get started, click the Run in Postman button below. This will fork both the API collection and the environment template into your Postman workspace in one simple step.

When you click the button, you’ll be prompted to fork the collection. Enter a name for your fork and select the workspace where you want it to be created.

The pre-configured environment will also be forked into your selected workspace, ready for you to add your API key.

Set your API key

To run requests, you’ll need to supply your secret API key and set it as an environment variable within your workspace.

1. To set any environment variable, create a new environment within Postman:

2. Add your secret key as a variable to the environment and save:

3. Set the environment to active:

4. Now, within the collection, set it to use the environment you just created:

If your environment is set up correctly, you should see your secret key value if you mouse over the secret_key_data variable in the Token field:

5. Be sure to save the collection after you’ve set the key:

Make a test call

You should be ready now to make a test call. An easy first call is to create a customer:

Since this is a test, no parameter updates are required. You can hit the Send button to run this request:

If your environment is set up, you’ll get a summary object back as the response to the call:

Add parameters to the call by clicking the Params tab, where you’ll see a list of available parameters. Select and populate the ones you want to use. Here’s an example of updating a target parameter:

You’ll see the updated target in the response:

Pricing

Our API credit plans are flexible and designed to scale with your needs. Choose from a monthly or annual subscription.

Endpoint costs can be found here: API Credits System.

Monthly subscription

Annual subscription

Commit to an annual plan and save 20% vs. paying monthly. Your full yearly credit allowance is available upfront at the start of the subscription.

Custom plans

Need a different volume of credits? Contact us at [email protected] to discuss a custom plan tailored to your specific requirements.