Page Crawl API
The Page Crawl API method provides an analysis of an individual page, including:
- Content Word Count
- Code to Text Ratio
- Page Title
- Page Title Length (character count)
- Page Description
- Page Description Length (character count)
- Page H1
- Internal Links Count
- External Links Count
This API method also includes options to request analysis of each individual internal link and external link that is found on the source page, providing the same data listed above for each link. The Page Crawl Results method also includes option to request the keyword analysis, providing the word count, the breakdown of the results for rank, SEO, SERP and more. The results include the keyword frequency, density, TF-IDF and more.
The monthly usage limit for this API is based on package capacity that is shared with the Site Audit
tool in the user interface.
Refer to Rank
Ranger API Overview
page for information on how to obtain API access,
obtain an API Key, error codes and a full list of API methods.
||The unique API key assigned to your account
||The full page URL including http or https
||The Rank Ranger Package ID can be obtained by running the Get Packages Info API
Packages have a capacity for Site Explorer requests, and this API utilizes that capacity.
||Optional: Analyze internal links. If you want internal links included, then add &analyze_il=true to the request
||Optional: Analyze external links. If you want links that are external to the domain to be included, then add &analyze_el=true to the request
||Optional: Analyze keywords. If you want the analysis of the keywords to be included in the report, then add &keyword_analysis=true to the request (available only for the Page Crawl Results Method)
||Output format options:
- &output=xml (this is the default format)
Either of these parameters can be added to the json output parameter:
(forces the results to come back as array instead of objects)
(causes the entire json to be wrapped as array)
Example Page Crawl Request
|Construct & test Keyword Research API requests in the API Console or follow one of these examples:
Example Page Crawl Results Request
|Insert the Query ID found in the response into this API request:
Page Crawl Results Example
Results can be ready in seconds or might take several minutes depending upon the number of links on the page and if you requested that external links be analyzed. If you request the results while the page crawl and link analysis are still in process, you will receive this type of response:
You can repeat the request for results. This is an example of page crawl results.
If you'd like to help determining which of our API plans is most appropriate for your needs, contact our service team
and an account manager will be happy to assist you.
If you already have a Rank Ranger plan and see an error message when accessing the Account Settings > API & Connected Apps
screen, then to obtain API access you will need to upgrade to a package that includes API access by completing a custom package request
form or contacting Rank Ranger support
with your requirements.
If your company has API services included in a plan and you aren't able to access the screen, contact your company's Rank Ranger account administrator to request that your user permissions
be set to include access to the Account Settings > API & Connected Apps
You can obtain API Keys per user if your Rank Ranger account has API access by navigating to
2. API Resources
3. API Key Generator
4. Click the Generate Key
5. Select a User and add a note (optional)
6. Click the Add
To make construction of API requests easy, we offer this API testing tool. Most parameters are included in the options of the console, however, you may need to add custom option parameters to your API requests based on the specific API you're using. Referencing the parameters information that is listed in the specific API method documentation, you can construct and test API requests in Rank Ranger's API Console
by navigating to:
2. API Resources > API Console
3. Select the Method and complete the applicable fields
4. Click the Generate
5. Test your API method by clicking the launch URL icon and view your results. Once your results are as you want them, copy that URL into your own application and modify as needed for each request.
Getting Started: Samples of APIs used for Creating Campaigns
We recommend reviewing our Best Practices Guide
prior to structuring campaigns.
Get Packages Info
: Required when there is more than 1 package in an account
Add a Profile
: An option for adding an identifier to your campaigns for categorization (e.g., by language, country, etc)
Get Profile ID list
: Optional Data needed for Add a Campaign
Obtain the Search Engine List
: Data needed for Add a Campaign
Add a Campaign
: Create a new campaign, response will include the Campaign ID number that is needed for adding a search engine and keywords
*Note that Profile ID is an optional field that you may use, if you choose not to use it, then please remove "&profile_id=ProfileIDnumber” from the end of this call
Add a Search Engine
: Add search engine to a campaign
Add a Keyword
: An optional field is available for keyword_identifier field, allowing you to add your own unique identifier to each keyword
Bulk Add Keywords
: You may download and use the spreadsheet found on the Campaign Settings > Keywords screen to organize and import your keywords, or use this API
You'll find additional API methods in the Account Management and Data documentation
Rank Ranger APIs can pull up to 100 queries per minute. If more than 10,000 API GET requests per hour is required, then there is an option available at an additional throughput fee, contact customer service for assistance.
Rank Reporting Method Limits
Research API Methods
- Rank Data & Research Reporting API methods can only provide data from campaigns tracking in your Rank Ranger account.
- You can run an unlimited number of queries through the API.
Search API Method Limits
- The variety of Research Method APIs have limits on the number of queries per day based on the capacity of your package. If you require additional units, please contact customer service and an account manager will provide you with package upgrade pricing.
- SEO Intelligence API method query limits are based on the number of units purchased for your custom plan (e.g., 1 unit = 1 keyword tracked on 1 search engine, 1 time).
- Search API plans do not include access to the reporting platform.