With the AWR API, you can programmatically extract and manage SEO data from your AWR account. Supporting a broad range of operations, the API facilitates easier project management, ranking, and market share data exports. It can also integrate seamlessly with third-party platforms, helping you combine data from various sources to create tailored reports and solutions.
Getting Started with the AWR API
API Access
To use the AWR API, you will need to have a valid API token. This token is available in the Settings → Connectors & API section of your AWR account.
The Developer API token is unlocked for all types of yearly plans and monthly subscriptions starting at the Agency level and higher.
API Endpoints
The base URL for all API requests is https://api.awrcloud.com, and HTTPS is required. The API system supports standard HTTPS requests in UTF-8 format for the following endpoints:
General API calls: https://api.awrcloud.com/v2/get.php
Market Share API calls: https://api.awrcloud.com/api/marketshare/v1/endpoint.php
API requests limit
All accounts have a default limit of 2,000 API calls per hour for most operations. If you need this limit increased, please contact us.
There are no additional fees for using the Developer API. Aside from your monthly subscription cost, you are not charged per API request.
Available operations with the AWR API
The AWR API supports a variety of operations, organized into three main categories:
Project management
Create, update, and delete projects
Retrieve project details, keywords, and dates
Request on-demand and keyword difficulty updates
Data export
List, get, and export ranking data
Export top sites, GWT data, visibility data, landing pages, CTR, search volume, and keyword difficulty
Market Share requests
Access project, search engine, website, keyword group, and metadata information
Retrieve domain keywords, domain URLs, and URL keywords
To check the full list of API calls and definitions, visit the API documentation page.
Basic structure of an API request
API requests generally include the base URL, action, API token, project name, and other parameters. Here are some examples:
Retrieve project details: https://api.awrcloud.com/v2/get.php?action=details&project=project+name&token=myAPItoken
How to configure an API call
Configuring an API call for Advanced Web Ranking involves a few straightforward steps, as follows:
Step 1: Obtain your API token
Log into your AWR account.
Navigate to the Settings → Connectors & API section.
Locate and copy your developer API token.
Step 2: Set up the API call
Use the base URL for API requests: https://api.awrcloud.com/v2/get.php (for general API calls) or https://api.awrcloud.com/api/marketshare/v1/endpoint.php (for Market Share API calls)
Append the necessary parameters to the base URL according to your specific operation.
For detailed guidance on creating and testing your calls, visit the API reference section.
Step 3: Run the API call
Browser-based requests: enter the configured API URL into your browser's address bar. The response will include a link for you to use to download the file containing the requested data.
Programmatic calls: create and execute scripts in any programming language to interact with the API and process the data as needed.
If you have any further questions, please feel free to contact our support team.