find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/agentseo-dev:agentseo-dev-domain-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AgentSEO Domain API
  version: 0.1.0
  description: API for agent-ready SEO data extraction, analysis, and async job processing.
servers:
- url: https://www.agentseo.dev/api/v1
  description: Production
- url: http://localhost:3000/api/v1
  description: Local
security:
- ApiKeyAuth: []
tags:
- name: Domain
paths:
  /domain/ranked-keywords:
    post:
      summary: Domain ranked keywords
      description: Find ranked keywords for a domain, subdomain, or URL and prioritize refresh opportunities. Costs 5 credits per 100 requested rows, minimum 5.
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainRankedKeywordsParams'
      responses:
        '200':
          description: Completed domain ranked keywords workflow with agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainRankedKeywordsResponse'
        '202':
          description: Job queued or still processing
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/QueuedJobResponse'
                - $ref: '#/components/schemas/SyncPendingResponse'
                - $ref: '#/components/schemas/JobStatusEnvelope'
      tags:
      - Domain
      operationId: postDomainRankedKeywords
      x-operation-id-source: derived
  /domain/relevant-pages:
    post:
      summary: Domain relevant pages
      description: Find traffic-carrying pages for a domain and route them into protect, refresh, expand, recover, or review actions. Costs 5 credits per 100 requested pages, minimum 5.
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainRelevantPagesParams'
      responses:
        '200':
          description: Completed domain relevant pages workflow with agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainRelevantPagesResponse'
        '202':
          description: Job queued or still processing
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/QueuedJobResponse'
                - $ref: '#/components/schemas/SyncPendingResponse'
                - $ref: '#/components/schemas/JobStatusEnvelope'
      tags:
      - Domain
      operationId: postDomainRelevantPages
      x-operation-id-source: derived
  /domain/competitors:
    post:
      summary: Domain competitors
      description: Discover search competitors for a domain and prioritize overlap, traffic gaps, threat level, and next analysis actions. Costs 5 credits per 100 requested competitors, minimum 5.
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainCompetitorsParams'
      responses:
        '200':
          description: Completed domain competitors workflow with agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainCompetitorsResponse'
        '202':
          description: Job queued or still processing
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/QueuedJobResponse'
                - $ref: '#/components/schemas/SyncPendingResponse'
                - $ref: '#/components/schemas/JobStatusEnvelope'
      tags:
      - Domain
      operationId: postDomainCompetitors
      x-operation-id-source: derived
  /domain/intersection:
    post:
      summary: Domain intersection
      description: Compare two domains at keyword level and prioritize shared deficits, current advantages, and target1-exclusive opportunities. Costs 5 credits per 100 requested keywords, minimum 5.
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainIntersectionParams'
      responses:
        '200':
          description: Completed domain intersection workflow with agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainIntersectionResponse'
        '202':
          description: Job queued or still processing
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/QueuedJobResponse'
                - $ref: '#/components/schemas/SyncPendingResponse'
                - $ref: '#/components/schemas/JobStatusEnvelope'
      tags:
      - Domain
      operationId: postDomainIntersection
      x-operation-id-source: derived
  /domain/traffic-estimate:
    post:
      summary: Domain traffic estimate
      description: Compare estimated search traffic across multiple domains, subdomains, or URLs before spending deeper analysis credits. Costs 5 credits per 25 supplied targets, minimum 5.
      parameters:
      - $ref: '#/components/parameters/SyncParam'
      - $ref: '#/components/parameters/ProjectIdHeader'
      - $ref: '#/components/parameters/WorkflowIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainTrafficEstimateParams'
      responses:
        '200':
          description: Completed domain traffic estimate workflow with agent_workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainTrafficEstimateResponse'
        '202':
          description: Job queued or still processing
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/QueuedJobResponse'
                - $ref: '#/components/schemas/SyncPendingResponse'
                - $ref: '#/components/schemas/JobStatusEnvelope'
      tags:
      - Domain
      operationId: postDomainTrafficEstimate
      x-operation-id-source: derived
components:
  schemas:
    QueuedJobResponse:
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
          - queued
          - processing
          - retrying
          - completed
          - failed
        message:
          type: string
        poll_url:
          type: string
        events_url:
          type: string
        retry_after_seconds:
          type: integer
    DomainRelevantPagesResponse:
      type: object
      properties:
        target:
          type: string
        location:
          type: object
          additionalProperties: true
        relevant_pages:
          type: object
          additionalProperties: true
        agent_workflow:
          $ref: '#/components/schemas/AgentWorkflow'
        markdown_summary:
          type: string
    JobContext:
      type: object
      properties:
        project_id:
          type: string
          nullable: true
        workflow_id:
          type: string
          nullable: true
    SyncPendingResponse:
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
          - pending
          - processing
        poll_url:
          type: string
        events_url:
          type: string
        retry_after_seconds:
          type: integer
    DomainTrafficEstimateResponse:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
        location:
          type: object
          additionalProperties: true
        traffic_estimate:
          type: object
          additionalProperties: true
        agent_workflow:
          $ref: '#/components/schemas/AgentWorkflow'
        markdown_summary:
          type: string
    AgentWorkflowAction:
      type: object
      properties:
        priority:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
        action:
          type: string
        why:
          type: string
    JobStatusEnvelope:
      type: object
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
          - queued
          - processing
          - retrying
          - completed
          - failed
        phase:
          type: string
          enum:
          - queued
          - submitting_analysis
          - waiting_analysis
          - transforming
          - finalizing
        progress:
          type: object
          properties:
            percent:
              type: number
            indeterminate:
              type: boolean
            eta_seconds:
              type: integer
              nullable: true
        attempt:
          type: integer
        max_attempts:
          type: integer
        message:
          type: string
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
        result:
          nullable: true
        error:
          type: object
          nullable: true
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
        context:
          allOf:
          - $ref: '#/components/schemas/JobContext'
          nullable: true
        poll_url:
          type: string
        events_url:
          type: string
        retry_after_seconds:
          type: integer
    DomainCompetitorsResponse:
      type: object
      properties:
        target:
          type: string
        location:
          type: object
          additionalProperties: true
        domain_competitors:
          type: object
          additionalProperties: true
        agent_workflow:
          $ref: '#/components/schemas/AgentWorkflow'
        markdown_summary:
          type: string
    DomainCompetitorsParams:
      type: object
      required:
      - target
      properties:
        target:
          type: string
          minLength: 1
          description: Domain or URL to inspect.
        location:
          type: string
          default: United States
          description: Human-friendly search market. If provided with location_code, location_code wins.
        location_code:
          type: integer
          minimum: 1
          description: Optional provider location code for deterministic geo-targeting.
        language:
          type: string
          default: en
        limit:
          type: integer
          minimum: 5
          maximum: 250
          default: 25
        min_intersections:
          type: integer
          minimum: 0
          maximum: 10000000
          default: 0
        max_rank_group:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
        sort_by:
          type: string
          enum:
          - overlap
          - competitor_traffic
          - traffic_gap
          - threat
          default: threat
    DomainRelevantPagesParams:
      type: object
      required:
      - target
      properties:
        target:
          type: string
          minLength: 1
          description: Domain to inspect.
        location:
          type: string
          default: United States
          description: Human-friendly search market. If provided with location_code, location_code wins.
        location_code:
          type: integer
          minimum: 1
          description: Optional provider location code for deterministic geo-targeting.
        language:
          type: string
          default: en
        limit:
          type: integer
          minimum: 10
          maximum: 250
          default: 50
        min_traffic:
          type: integer
          minimum: 0
          maximum: 10000000
          default: 0
        historical_serp_mode:
          type: string
          enum:
          - live
          - lost
          - all
          default: live
        sort_by:
          type: string
          enum:
          - estimated_traffic
          - keyword_count
          - top3
          - opportunity
          default: estimated_traffic
    DomainTrafficEstimateParams:
      type: object
      required:
      - targets
      properties:
        targets:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: string
            minLength: 1
          description: Domains, subdomains, or absolute page URLs to estimate.
        location:
          type: string
          default: United States
          description: Human-friendly search market. If provided with location_code, location_code wins.
        location_code:
          type: integer
          minimum: 1
          description: Optional provider location code for deterministic geo-targeting.
        language:
          type: string
          default: en
        include_paid:
          type: boolean
          default: true
        include_featured_snippet:
          type: boolean
          default: true
        include_local_pack:
          type: boolean
          default: false
        sort_by:
          type: string
          enum:
          - organic_traffic
          - total_traffic
          - paid_traffic
          - opportunity
          - target
          default: organic_traffic
    DomainRankedKeywordsParams:
      type: object
      required:
      - target
      properties:
        target:
          type: string
          minLength: 1
          description: Domain, subdomain, or page URL to inspect.
        location:
          type: string
          default: United States
          description: Human-friendly search market. If provided with location_code, location_code wins.
        location_code:
          type: integer
          minimum: 1
          description: Optional provider location code for deterministic geo-targeting.
        language:
          type: string
          default: en
        limit:
          type: integer
          minimum: 10
          maximum: 250
          default: 50
        min_search_volume:
          type: integer
          minimum: 0
          maximum: 1000000
          default: 0
        max_rank:
          type: integer
          minimum: 1
          maximum: 100
          default: 100
        sort_by:
          type: string
          enum:
          - opportunity
          - estimated_traffic
          - rank
          - search_volume
          - cpc
          default: opportunity
        include_lost:
          type: boolean
          default: false
    AgentWorkflowEvidence:
      type: object
      properties:
        finding:
          type: string
        detail:
          type: string
        severity:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
    DomainIntersectionResponse:
      type: object
      properties:
        target1:
          type: string
        target2:
          type: string
        location:
          type: object
          additionalProperties: true
        domain_intersection:
          type: object
          additionalProperties: true
        agent_workflow:
          $ref: '#/components/schemas/AgentWorkflow'
        markdown_summary:
          type: string
    DomainIntersectionParams:
      type: object
      required:
      - target1
      - target2
      properties:
        target1:
          type: string
          minLength: 1
          description: First domain or URL to inspect.
        target2:
          type: string
          minLength: 1
          description: Second domain or URL to compare against.
        location:
          type: string
          default: United States
          description: Human-friendly search market. If provided with location_code, location_code wins.
        location_code:
          type: integer
          minimum: 1
          description: Optional provider location code for deterministic geo-targeting.
        language:
          type: string
          default: en
        limit:
          type: integer
          minimum: 5
          maximum: 250
          default: 25
        intersections:
          type: boolean
          default: true
          description: true returns shared keywords; false returns keywords where target1 ranks and target2 does not.
        min_search_volume:
          type: integer
          minimum: 0
          maximum: 10000000
          default: 0
        sort_by:
          type: string
          enum:
          - opportunity
          - search_volume
          - traffic_gap
          - rank_gap
          - cpc
          default: opportunity
    DomainRankedKeywordsResponse:
      type: object
      properties:
        target:
          type: string
        location:
          type: object
          additionalProperties: true
        ranked_keywords:
          type: object
          additionalProperties: true
        agent_workflow:
          $ref: '#/components/schemas/AgentWorkflow'
        markdown_summary:
          type: string
    AgentWorkflowNextCall:
      type: object
      properties:
        endpoint:
          type: string
        reason:
          type: string
    AgentWorkflow:
      type: object
      properties:
        summary:
          type: string
        decision:
          type: string
          enum:
          - ready
          - act_now
          - monitor
          - blocker
        confidence:
          type: number
          minimum: 0
          maximum: 1
        recommended_actions:
          type: array
          items:
            $ref: '#/components/schemas/AgentWorkflowAction'
        evidence:
          type: array
          items:
            $ref: '#/components/schemas/AgentWorkflowEvidence'
        limitations:
          type: array
          items:
            type: string
        next_calls:
          type: array
          items:
            $ref: '#/components/schemas/AgentWorkflowNextCall'
  parameters:
    SyncParam:
      name: sync
      in: query
      required: false
      schema:
        type: boolean
        default: false
      description: Open a short inline processing window when supported by the endpoint. If the result is not ready yet, the endpoint may still return 202 with a queued payload that includes poll_url, events_url, and retry_after_seconds.
    ProjectIdHeader:
      name: x-project-id
      in: header
      required: false
      schema:
        type: string
        maxLength: 120
      description: Optional attribution label for grouping usage and jobs by project.
    WorkflowIdHeader:
      name: x-workflow-id
      in: header
      required: false
      schema:
        type: string
        maxLength: 120
      description: Optional attribution label for grouping usage and jobs by workflow or agent run.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key