SEMrush Integration — ModuleX AI

Field	Description	Required	Format
SEMrush API Key	Your SEMrush API key for authentication	Yes	`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

domain_overview — Get domain overview data including organic/paid search traffic, keywords, and rankings

Parameters

string

required

Domain name to analyze

string

Regional database (Default: us)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "DomainOverviewOutput",
  "type": "object"
}

domain_organic_keywords — Get organic keywords for a domain with position, volume, and traffic data

Parameters

string

required

Domain name to analyze

string

Regional database (e.g. ‘us’, ‘uk’, ‘ca’, ‘de’, ‘fr’) (Default: us)

integer

Maximum number of records to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "DomainOrganicKeywordsOutput",
  "type": "object"
}

domain_paid_keywords — Get paid keywords for a domain with ad position and CPC data

Parameters

string

required

Domain name to analyze

string

Regional database (e.g. ‘us’, ‘uk’, ‘ca’, ‘de’, ‘fr’) (Default: us)

integer

Maximum number of records to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "DomainPaidKeywordsOutput",
  "type": "object"
}

competitors — Get organic-search competitors for a domain

Parameters

string

required

Domain name to analyze

string

Regional database (e.g. ‘us’, ‘uk’, ‘ca’, ‘de’, ‘fr’) (Default: us)

integer

Maximum number of records to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "CompetitorsOutput",
  "type": "object"
}

backlinks — Get backlinks for a domain or URL with source details and authority scores

Parameters

string

required

Domain or URL to analyze

integer

Maximum backlinks to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "BacklinksOutput",
  "type": "object"
}

backlinks_domains — Get referring domains for a domain or URL

Parameters

string

required

Domain or URL to analyze

integer

Maximum referring domains to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "BacklinksDomainsOutput",
  "type": "object"
}

keyword_overview — Get overview data for a keyword including volume, CPC, and competition

Parameters

string

required

Keyword to analyze

string

Database to use (Default: us)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "KeywordOverviewOutput",
  "type": "object"
}

keyword_overview_single_db — Get detailed keyword overview from a specific database with difficulty score

Parameters

string

required

Keyword to analyze

string

required

Database to use

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "KeywordOverviewSingleDbOutput",
  "type": "object"
}

batch_keyword_overview — Analyze up to 100 keywords at once in a specific database

Parameters

array

required

Array of keywords (max 100)

string

required

Database to use

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "BatchKeywordOverviewOutput",
  "type": "object"
}

Parameters

string

required

Keyword to analyze

string

Database to use (Default: us)

integer

Maximum number of results (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "RelatedKeywordsOutput",
  "type": "object"
}

keyword_organic_results — Get domains ranking in Google's top 100 for a keyword

Parameters

string

required

Keyword to analyze

string

required

Database to use

integer

Maximum number of results (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "KeywordOrganicResultsOutput",
  "type": "object"
}

keyword_paid_results — Get domains in Google's paid search results for a keyword

Parameters

string

required

Keyword to analyze

string

required

Database to use

integer

Maximum number of results (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "KeywordPaidResultsOutput",
  "type": "object"
}

keyword_ads_history — Get domains that bid on a keyword in the last 12 months

Parameters

string

required

Keyword to analyze

string

required

Database to use

integer

Maximum number of results (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "KeywordAdsHistoryOutput",
  "type": "object"
}

broad_match_keywords — Get broad matches and alternate search queries for a keyword

Parameters

string

required

Keyword to analyze

string

required

Database to use

integer

Maximum number of results (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "BroadMatchKeywordsOutput",
  "type": "object"
}

Parameters

string

required

Keyword to analyze

string

required

Database to use

integer

Maximum number of results (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "PhraseQuestionsOutput",
  "type": "object"
}

keyword_difficulty — Get difficulty index (0-100) for ranking in Google's top 10

Parameters

array

required

Array of keywords (max 100)

string

required

Database to use

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "records": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "KeywordDifficultyOutput",
  "type": "object"
}

traffic_summary — Get traffic summary data for domains (requires .Trends API access)

Parameters

array

required

Array of domains to analyze

string

Country code (Default: us)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "TrafficSummaryOutput",
  "type": "object"
}

traffic_sources — Get traffic sources breakdown for a domain (requires .Trends API access)

Parameters

string

required

Domain to analyze

string

Country code (Default: us)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "TrafficSourcesOutput",
  "type": "object"
}

api_units_balance — Check the remaining API units balance in your SEMrush account

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "units": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Units"
    }
  },
  "required": [
    "success"
  ],
  "title": "ApiUnitsBalanceOutput",
  "type": "object"
}

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Limits & Quotas

​Related integrations

Nasdaq Data Link

Short.io

Ahrefs

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Limits & Quotas

Related integrations

Links