Skip to main content

Moz API

Moz provides SEO data and analytics, including Domain Authority, Page Authority, and Brand Authority, link and linking-domain data, anchor text, ranking keywords, keyword metrics, and search engine results pages. The Moz API connector reads this data from the Moz API with an API token. Most templates use Moz row quota; a few, such as quota lookup and the global top pages and domains lists, are free.

Moz API icon

Power end-to-end data operations for your Moz API API with Nexla. Our bi-directional Moz API connector is purpose-built for Moz API, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Moz API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Moz API workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to the Moz API with a Moz API token, which it sends in the x-moz-token request header. The same token also works for the two legacy Links API v2 templates. Moz's older Access ID and Secret Key (Basic authentication) are not used by this connector.

  1. Sign up for a Moz API plan, or sign in to your existing Moz API account. The free plan includes 50 rows of quota per month and requires a valid credit card; Moz does not charge the card unless you upgrade.

  2. Open the Moz API dashboard, and click + Add Token to create an API token. An account can have up to five active tokens.

  3. Copy the token and store it securely.

For more information, see Moz's authentication guide and getting started guide.

Moz API quota

Most Moz API methods use rows from your plan's monthly quota, usually one row for each result returned. The free plan has 50 rows per month, so a single run of a list template can use up a large share of it. Paid plans include more rows, and whether usage beyond your allowance is billed as overage depends on your plan. The quota usage section below lists the cost of each template. Use the free Get Quota template to check your remaining rows and whether overages are enabled.

Repeated authentication failures

Moz blocks the calling IP address for 30 minutes after ten 401 or 403 responses within 5 minutes; a 403 includes running out of quota. If a credential test or flow fails with one of these errors, fix the token or quota before retrying. See Moz's error handling guide for details.

Authenticate​

Credentials required​

Moz API token, sent as the x-moz-token header. Create one on the Moz API dashboard (moz.com/api/dashboard > + Add Token). The connection test calls quota.lookup, which uses no quota.

FieldRequiredSecretDescription
API TokenYesYesMoz API token from the Moz API dashboard (moz.com/api/dashboard > + Add Token). The same token works for the current Moz API and the legacy Links API v2.

Create a credential in Nexla​

  1. To create a new Moz API credential, after selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Moz API

MozCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. In the API Token field, enter the API token you created on the Moz API dashboard.

    The API token is sensitive and should be kept secure. If it is exposed, delete it on the Moz API dashboard, create a new token, and update this credential.

  3. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source creation.

Nexla tests the credential by calling the Moz quota.lookup method, which uses no quota.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Moz API connector tile from the list of available connectors, then select the credential that will be used to connect to your Moz account, and click Next; or, create a new Moz API credential for use in this flow.

Quota usage​

Moz charges rows from your data quota (api.limits.data.rows) unless noted otherwise. Templates that return a list fetch a single page per run and charge for each result on that page, so their Max Results setting caps the cost of a run. Each scheduled run calls Moz again and uses quota again.

TemplateCost per run
Get Quota, Get Index ID, List Global Top Pages, List Global Top DomainsFree
List LocalesFree (zero rows), but the account must have row quota
Get Site Metrics, Get Brand Authority, Get Site Metrics Distributions, Get Final Redirect Target, Get Link Status, Count Ranking Keywords1 row
Get Keyword Difficulty, Get Keyword Volume, Get Keyword Organic CTR, Get Keyword Priority, Get Keyword Search Intent1 row
Get Keyword MetricsUp to 4 rows (1 per metric with a value)
Get Keyword Metrics (Multiple)Up to 5 rows per keyword
Get SERP15 rows, less 1 per metric without a value
Get Site Metrics (Multiple), Get Site Metric History, Get Link Status (Multiple)1 row per site, history item, or pair returned
List Top Pages, List Links, List Links From Domain, List Links By Anchor Text, List Linking Domains, List Recently Gained Linking Domains, List Recently Lost Linking Domains, List Anchor Text, List Ranking Keywords, List Keyword Suggestions1 row per result returned
Get Link IntersectN rows per result, where N is the number of sites in both lists
List Site CompetitorsLinks API (mozscape) quota: 50 units reserved per call, then 2 per competitor returned
Global Top Pages (Links API v2), Global Top Root Domains (Links API v2)Not documented by Moz

Costs come from each method's page in the Moz API docs and may change; check the linked page for the current cost.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Moz API endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

All templates except the two legacy ones send a JSON-RPC request to https://api.moz.com/jsonrpc. Settings described as JSON arrays are sent to Moz as-is, so they must be valid JSON; Moz rejects malformed requests before any quota is used.

Quota and reference data​

Get Quota

This endpoint template returns the rows used and allotted in the current billing period for one Moz API quota, and whether overages are enabled. Use it to check your remaining quota before running other templates.

  • Quota: Free. Uses no quota.
  • Select the Quota: api.limits.data.rows (default; the main Moz API quota), api.limits.beta.rows (beta methods), or api.limits.mozscape.rows (used by List Site Competitors and the Links API).
  • Reference: Moz API docs: Get Quota

Get Index ID

This endpoint template returns the ID of the current Moz link index. The ID changes when Moz updates the index, so you can use it to decide when to refresh link data.

List Locales

This endpoint template lists the locales a search engine supports, for use as the Locale of keyword templates.

  • Quota: Free. Uses zero rows, but the account must have row quota.
  • Select the Search Engine: google (default), bing, or yahoo.
  • Reference: Moz API docs: List Locales

List Global Top Pages

This endpoint template returns one page of the pages with the highest Page Authority in the Moz index, with their link metrics.

List Global Top Domains

This endpoint template returns one page of the root domains with the highest Domain Authority in the Moz index, with their link metrics.

Site metrics​

Get Site Metrics

This endpoint template returns Domain Authority, Page Authority, Spam Score, and link counts for one site.

  • Quota: 1 row per call. Moz makes a call free only when it exactly matches its documented example (moz.com with scope domain).
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Reference: Moz API docs: Get Site Metrics

Get Site Metrics (Multiple)

This endpoint template returns Domain Authority, Page Authority, Spam Score, and link counts for up to 50 sites, one record per site.

Get Brand Authority

This endpoint template returns the Brand Authority score of a domain.

Get Site Metrics Distributions

This endpoint template returns how a site's linking root domains and pages are spread across Domain Authority and Spam Score buckets.

  • Quota: 1 row per call.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Reference: Moz API docs: Get Site Metrics Distributions

Get Site Metric History

This endpoint template returns the monthly history of selected metrics, such as Domain Authority, for one site.

  • Quota: 1 row for each history item returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Enter Metrics (JSON) as a JSON array of metric names, for example ["domain_authority", "page_authority"] (default ["domain_authority"]).
  • Reference: Moz API docs: Get Site Metric History

List Top Pages

This endpoint template returns one page of the top pages on a domain or subdomain, by Page Authority.

  • Quota: 1 row for each page returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain or subdomain. The default is domain.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: List Top Pages

Get Final Redirect Target

This endpoint template returns the final target of a page after following the redirects known to the Moz index.

  • Quota: 1 row per call.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Reference: Moz API docs: Get Final Redirect Target

List Site Competitors

This endpoint template returns the top ranking competitors of a site, ordered by rivalry. Moz runs this method asynchronously: Nexla starts the request, then checks for the result every 10 seconds, up to 11 times.

  • Quota: Uses the Links API (mozscape) quota rather than data rows: 50 units are reserved for each call, then 2 units for each competitor returned. Checking for the result is free.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, or subfolder. The default is domain.
  • Select the Locale: en-US (default), en-GB, en-CA, or en-AU.
  • Reference: Moz API docs: List Site Competitors

List Links

This endpoint template returns one page of links pointing to a site, ordered by the Page Authority of the linking page.

  • Quota: 1 row for each link returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: List Links

List Links From Domain

This endpoint template returns one page of links to a site that come from a single root domain.

  • Quota: 1 row for each link returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Enter the Linking Domain to filter by, for example wikipedia.org.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: List Links From Domain

List Links By Anchor Text

This endpoint template returns one page of links to a site whose anchor text exactly matches a string.

  • Quota: 1 row for each link returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Enter the Anchor Text to match exactly, for example click here.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: List Links By Anchor Text

Get Link Intersect

This endpoint template finds sites that link to some targets but not to others, which is useful for link-gap analysis. It returns one page of results.

  • Quota: N rows for each result returned, where N is the number of sites in both lists.
  • Enter Linked-To Sites (JSON) as a JSON array of site queries the results must link to, for example [{"query": "example.com", "scope": "domain"}].
  • Enter Not-Linked-To Sites (JSON) as a JSON array of site queries the results must not link to, or [] (default) for none.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: Get Link Intersect

Get Link Status

This endpoint template checks whether a source site links to a target site.

  • Quota: 1 row per call.
  • Enter the Target Site (the site that may be linked to) and select its Target Scope.
  • Enter the Source Site (the site that may link to the target) and select its Source Scope.
  • Scopes are domain (default), subdomain, subfolder, or url.
  • Reference: Moz API docs: Get Link Status

Get Link Status (Multiple)

This endpoint template checks several source and target pairs at once, returning one record per pair.

  • Quota: 1 row for each result returned.
  • Enter Link Checks (JSON) as a JSON array of pairs, each with a target_site_query and a source_site_query object (query and scope).
  • Reference: Moz API docs: Get Link Status (Multiple)

List Linking Domains

This endpoint template returns one page of root domains linking to a site, with link counts.

  • Quota: 1 row for each domain returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: List Linking Domains

List Recently Gained Linking Domains

This endpoint template returns one page of root domains that started linking to a site in the past 60 days.

  • Quota: 1 row for each domain returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: List Recently Gained Linking Domains

List Recently Lost Linking Domains

This endpoint template returns one page of root domains that stopped linking to a site in the past 60 days.

  • Quota: 1 row for each domain returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: List Recently Lost Linking Domains

List Anchor Text

This endpoint template returns one page of the anchor texts used in links to a site, with counts.

  • Quota: 1 row for each anchor text returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Enter Max Results (1 to 50, default 25). Each result uses a row, so this caps the cost of a run.
  • Reference: Moz API docs: List Anchor Text

Keywords and SERPs​

List Ranking Keywords

This endpoint template returns one page of the keywords a site ranks for in the top 50 results, with rank, difficulty, and volume.

  • Quota: 1 row for each keyword returned.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, subfolder, or url (a single page). The default is domain.
  • Select the Locale: en-US (default), en-GB, en-CA, or en-AU.
  • Enter the Page Number (starting at 0) and Max Results (1 to 500 per page, default 25). Each result uses a row.
  • Reference: Moz API docs: List Ranking Keywords

Count Ranking Keywords

This endpoint template returns how many keywords a site ranks for in the top 50 results, by position.

  • Quota: 1 row per call.
  • Enter the Site: a domain or URL, for example moz.com or https://moz.com/blog (default moz.com).
  • Select the Scope: domain, subdomain, or url. The default is domain.
  • Select the Locale: en-US (default), en-GB, en-CA, or en-AU.
  • Reference: Moz API docs: Count Ranking Keywords

Get Keyword Metrics

This endpoint template returns search volume, difficulty, organic click-through rate, and priority for one keyword.

  • Quota: 1 row for each metric that has a value, up to 4 rows per call.
  • Enter the Keyword (1 to 255 characters).
  • Enter the Locale as a Google language-country pair, for example en-US (default) or fr-FR. Use List Locales for valid values.
  • Select the Device: desktop (default), mobile_android, or mobile_ios.
  • Select the Search Engine: google (default), bing, or yahoo.
  • Reference: Moz API docs: Get Keyword Metrics

Get Keyword Metrics (Multiple)

This endpoint template returns volume, difficulty, click-through rate, priority, and intent for up to 50 keywords, one record per keyword.

  • Quota: 1 row for each metric that has a value, up to 5 rows per keyword.
  • Enter Keywords (JSON) as a JSON array of up to 50 queries, each with keyword, locale, device, and engine, for example [{"keyword": "seo software", "locale": "en-US", "device": "desktop", "engine": "google"}].
  • Reference: Moz API docs: Get Keyword Metrics (Multiple)

Get Keyword Difficulty

This endpoint template returns the difficulty score of a keyword.

  • Quota: 1 row per call.
  • Enter the Keyword (1 to 255 characters).
  • Enter the Locale as a Google language-country pair, for example en-US (default) or fr-FR. Use List Locales for valid values.
  • Select the Device: desktop (default), mobile_android, or mobile_ios.
  • Select the Search Engine: google (default), bing, or yahoo.
  • Reference: Moz API docs: Get Keyword Difficulty

Get Keyword Volume

This endpoint template returns the monthly search volume of a keyword.

  • Quota: 1 row per call.
  • Enter the Keyword (1 to 255 characters).
  • Enter the Locale as a Google language-country pair, for example en-US (default) or fr-FR. Use List Locales for valid values.
  • Select the Device: desktop (default), mobile_android, or mobile_ios.
  • Select the Search Engine: google (default), bing, or yahoo.
  • Reference: Moz API docs: Get Keyword Volume

Get Keyword Organic CTR

This endpoint template returns the organic click-through rate (opportunity) of a keyword.

  • Quota: 1 row per call.
  • Enter the Keyword (1 to 255 characters).
  • Enter the Locale as a Google language-country pair, for example en-US (default) or fr-FR. Use List Locales for valid values.
  • Select the Device: desktop (default), mobile_android, or mobile_ios.
  • Select the Search Engine: google (default), bing, or yahoo.
  • Reference: Moz API docs: Get Keyword Organic CTR

Get Keyword Priority

This endpoint template returns the priority score of a keyword.

  • Quota: 1 row per call.
  • Enter the Keyword (1 to 255 characters).
  • Enter the Locale as a Google language-country pair, for example en-US (default) or fr-FR. Use List Locales for valid values.
  • Select the Device: desktop (default), mobile_android, or mobile_ios.
  • Select the Search Engine: google (default), bing, or yahoo.
  • Reference: Moz API docs: Get Keyword Priority

Get Keyword Search Intent

This endpoint template returns navigational, informational, commercial, and transactional intent scores for a keyword.

  • Quota: 1 row per call.
  • Enter the Keyword (1 to 255 characters).
  • Enter the Locale as a Google language-country pair, for example en-US (default) or fr-FR. Use List Locales for valid values.
  • Select the Device: desktop (default), mobile_android, or mobile_ios.
  • Select the Search Engine: google (default), bing, or yahoo.
  • Reference: Moz API docs: Get Keyword Search Intent

Get SERP

This endpoint template returns the most recently collected search results for a keyword, one record per result.

  • Quota: 15 rows per call, less 1 for each metric without a value. This is the most expensive template per call.
  • Enter the Keyword (1 to 255 characters).
  • Enter the Locale as a Google language-country pair, for example en-US (default) or fr-FR. Use List Locales for valid values.
  • Select the Device: desktop (default), mobile_android, or mobile_ios.
  • Select the Search Engine: google (default), bing, or yahoo.
  • Reference: Moz API docs: Get SERP

List Keyword Suggestions

This endpoint template returns one page of related keyword suggestions for a keyword (Google, desktop). Moz runs this method asynchronously: Nexla starts the request, then checks for the result every 10 seconds, up to 11 times.

  • Quota: 1 row for each suggestion returned. Checking for the result is free.
  • Enter the Keyword (1 to 255 characters).
  • Enter the Locale, for example en-US (default).
  • Select the Strategy: default (default), related_synonyms, or related_topics.
  • Enter the Page Number (starting at 0) and Max Results (1 to 50, default 25).
  • Reference: Moz API docs: List Keyword Suggestions

These two templates call the older Links API v2 at https://lsapi.seomoz.com/v2/ with the same API token. Prefer the free List Global Top Pages and List Global Top Domains templates for new flows.

Global Top Pages (Links API v2)

This endpoint template returns the top 500 pages in the Moz index by Page Authority, with link metrics, from the legacy Links API v2 (https://lsapi.seomoz.com/v2/global_top_pages). Nexla pages through all 500 results, 50 per call.

Global Top Root Domains (Links API v2)

This endpoint template returns the top 500 root domains in the Moz index by Domain Authority, with link metrics, from the legacy Links API v2 (https://lsapi.seomoz.com/v2/global_top_root_domains). Nexla pages through all 500 results, 50 per call.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving. Testing a template calls Moz, so it uses quota unless the template is free.

Manual configuration​

Moz API data sources can also be manually configured to ingest data from any valid Moz API method not covered by the pre-built templates. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Every Moz API method is called with POST at https://api.moz.com/jsonrpc, with a JSON body that names the method, for example {"jsonrpc": "2.0", "id": "my-request-id-0000000001", "method": "data.site.metrics.fetch", "params": {"data": {"site_query": {"query": "moz.com", "scope": "domain"}}}}. The id must be at least 24 characters of letters, numbers, and hyphens. Results are under $.result. The x-moz-token header is added automatically from your credential.

Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.