> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thehog.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get SEO keywords

> Returns organic search keywords for a domain with optional filters and search-type segmentation.

# POST /api/v1/platform/scrapers/seo/keywords

> List organic search keywords for a domain.

Returns ranked keywords with volume, position, difficulty, and click estimates. Use `searchType` to focus on gains, losses, newly ranked terms, or the most valuable keywords.

## Example

```bash theme={null} theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST https://developer.thehog.ai/api/v1/platform/scrapers/seo/keywords \
  -H "X-Access-Key: ak_xxxxxxxxxxxxxxxx" \
  -H "X-Secret-Key: sk_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"domain": "acme.com", "searchType": "MostValuable", "pageSize": 25}'
```


## OpenAPI

````yaml api-reference/openapi.json POST /api/v1/platform/scrapers/seo/keywords
openapi: 3.0.0
info:
  title: The Hog API
  description: Public API reference for The Hog.
  version: '1.0'
  contact: {}
servers:
  - url: https://developer.thehog.ai
security: []
tags: []
paths:
  /api/v1/platform/scrapers/seo/keywords:
    post:
      tags:
        - Scrapers
      summary: Get SEO keywords
      description: >-
        Returns organic search keywords for a domain with optional filters and
        search-type segmentation.
      operationId: getSeoKeywords
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformSeoKeywordsDto'
      responses:
        '200':
          description: Organic search keywords for a domain.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                additionalProperties: false
                properties:
                  data:
                    $ref: '#/components/schemas/SearchIntelligenceKeywordsResponseDto'
                  meta:
                    $ref: '#/components/schemas/PublicResponseMetaDto'
        '400':
          description: The request body or parameters are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponseDto'
              example:
                statusCode: 400
                error: Bad Request
                message: Validation failed
                path: /api/v1/search
                timestamp: '2026-05-21T09:08:10.000Z'
                requestId: 506af9b3-01a9-43be-9eb4-8458fe3e4f5b
                errors:
                  - property: body.query
                    message: query must be a string
                    constraints:
                      isString: query must be a string
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponseDto'
              example:
                statusCode: 401
                error: Unauthorized
                message: Authentication is required.
                path: /api/v1/search
                timestamp: '2026-05-21T09:08:10.000Z'
                requestId: 506af9b3-01a9-43be-9eb4-8458fe3e4f5b
        '402':
          description: The organization does not have enough credits for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponseDto'
              example:
                statusCode: 402
                error: Payment Required
                message: Insufficient credits.
                path: /api/v1/search
                timestamp: '2026-05-21T09:08:10.000Z'
                requestId: 506af9b3-01a9-43be-9eb4-8458fe3e4f5b
        '500':
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponseDto'
              example:
                statusCode: 500
                error: Internal Server Error
                message: An unexpected error occurred.
                path: /api/v1/search
                timestamp: '2026-05-21T09:08:10.000Z'
                requestId: 506af9b3-01a9-43be-9eb4-8458fe3e4f5b
        '502':
          description: The upstream service could not complete the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponseDto'
              example:
                statusCode: 502
                error: Bad Gateway
                message: An unexpected error occurred.
                path: /api/v1/search
                timestamp: '2026-05-21T09:08:10.000Z'
                requestId: 506af9b3-01a9-43be-9eb4-8458fe3e4f5b
      security:
        - AccessKey: []
          SecretKey: []
components:
  schemas:
    PlatformSeoKeywordsDto:
      type: object
      properties:
        domain:
          type: string
          example: acme.com
          description: Domain to analyze organic search keywords for.
        searchType:
          type: string
          enum:
            - GainedClicks
            - LostClicks
            - GainedRanks
            - LostRanks
            - MostValuable
            - NewlyRanked
            - JustMadeIt
            - JustFellOff
          example: MostValuable
        pageSize:
          type: number
          default: 25
          minimum: 1
          maximum: 100
        searchVolumeMin:
          type: number
          minimum: 0
        searchVolumeMax:
          type: number
          minimum: 0
        rankMin:
          type: number
          minimum: 1
        rankMax:
          type: number
          minimum: 1
        includeTerms:
          type: string
          description: Comma-separated terms that must appear in keywords.
        excludeTerms:
          type: string
          description: Comma-separated terms to exclude from keywords.
      required:
        - domain
        - searchType
    SearchIntelligenceKeywordsResponseDto:
      type: object
      properties:
        domain:
          type: string
          nullable: true
        seedKeyword:
          type: string
          nullable: true
        includedDomains:
          nullable: true
          type: array
          items:
            type: string
        excludedDomains:
          nullable: true
          type: array
          items:
            type: string
        searchType:
          type: string
          nullable: true
        intent:
          type: string
          enum:
            - seo
            - aeo
            - geo
            - ppc
        resultCount:
          type: number
        totalMatchingResults:
          type: number
        keywords:
          type: array
          items:
            $ref: '#/components/schemas/SearchIntelligenceKeywordRowResponseDto'
      required:
        - intent
        - resultCount
        - totalMatchingResults
        - keywords
    PublicResponseMetaDto:
      type: object
      properties:
        requestId:
          type: string
      required:
        - requestId
    PublicErrorResponseDto:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: Validation failed
        path:
          type: string
          example: /api/v1/search
        requestId:
          type: string
          example: 506af9b3-01a9-43be-9eb4-8458fe3e4f5b
        timestamp:
          type: string
          example: '2026-05-21T09:08:10.000Z'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/PublicValidationErrorItemDto'
      required:
        - statusCode
        - error
        - message
        - path
        - timestamp
    SearchIntelligenceKeywordRowResponseDto:
      type: object
      properties:
        keyword:
          type: string
        searchVolume:
          type: number
          nullable: true
        rank:
          type: number
          nullable: true
        rankingDifficulty:
          type: number
          nullable: true
        totalMonthlyClicks:
          type: number
          nullable: true
        percentOrganicClicks:
          type: number
          nullable: true
        broadCostPerClick:
          type: number
          nullable: true
        isQuestion:
          type: boolean
          nullable: true
      required:
        - keyword
    PublicValidationErrorItemDto:
      type: object
      properties:
        property:
          type: string
          example: body.query
        message:
          type: string
          example: query must be a string
        constraints:
          type: object
          additionalProperties:
            type: string
          example:
            isString: query must be a string
      required:
        - property
        - message
  securitySchemes:
    AccessKey:
      type: apiKey
      in: header
      name: X-Access-Key
      description: The public API key from the Credentials page.
    SecretKey:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: The API secret shown when the credential is created.

````