openapi: 3.2.0 info: title: Karma.Domains Public Reports API description: 'Public API for Karma.Domains: programmatic access to domain intelligence — reports across auctions, expired, backorder, and buy-now inventories, SEO and authority metrics, Wayback history, availability checks, and Karma Metric.' contact: name: Karma.Domains url: https://karma.domains/ email: hello@karma.domains version: 1.0.0 x-guidance: 'Paid routes use x402 agent credits. If a request returns HTTP 402, read PAYMENT-REQUIRED and retry the same URL with PAYMENT-SIGNATURE. Optional X-Karma-Plan-Id selects a concrete credit pack. Saved filters: GET/POST /v1/user/saved-filters and GET/PATCH/DELETE /v1/user/saved-filters/{id}. Webhooks: POST /v1/webhooks with an HTTPS URL from Zapier, Make, n8n, or IFTTT. SEO enrich: POST .../enrich-seo then poll GET /v1/reports/enrich-jobs/{job_id}.' servers: - url: https://api.karma.domains description: Public API (canonical) - url: https://karma.domains description: OpenAPI mirror (same spec) tags: - name: Reports paths: /v1/reports/search: post: tags: - Reports summary: Search Bases Reports description: 'Search reports across all bases (auctions, expired, backorder, buynow). Uses the same filters as the app table with ``report_type=all``. Each list item includes ``report_url`` (link to the report in the web app). For a simple exact domain lookup (identifiers only), use ``GET /by-domain?domain=``. For the full report body, use ``GET /report?report_type=&report_id=``. Agent accounts: 1 credit per call from spendable balance.' operationId: search_bases_reports_v1_reports_search_post security: - Bearer: [] parameters: - name: sort_by in: query required: false schema: enum: - report_type - auction_source - karmascore - karmametric - brandscore - openpagerank - sr_as - sr_bl - sr_rd - sr_traffic - ahrefs_dr - ahrefs_ur - moz_da - moz_ss - moz_bl - moz_rd - majestic_tf - majestic_cf - majestic_ratio - majestic_bl - majestic_rd - ke_etv - ke_total - wa_age - wa_last_snap - sw_last_traffic - auction_bids - auction_price - auction_end_time - added_at type: string description: 'Table column name to sort by. Allowed values: report_type, auction_source, karmascore, karmametric, brandscore, openpagerank, sr_as, sr_bl, sr_rd, sr_traffic, ahrefs_dr, ahrefs_ur, moz_da, moz_ss, moz_bl, moz_rd, majestic_tf, majestic_cf, majestic_ratio, majestic_bl, majestic_rd, ke_etv, ke_total, wa_age, wa_last_snap, sw_last_traffic, auction_bids, auction_price, auction_end_time, added_at' default: added_at title: Sort By description: 'Table column name to sort by. Allowed values: report_type, auction_source, karmascore, karmametric, brandscore, openpagerank, sr_as, sr_bl, sr_rd, sr_traffic, ahrefs_dr, ahrefs_ur, moz_da, moz_ss, moz_bl, moz_rd, majestic_tf, majestic_cf, majestic_ratio, majestic_bl, majestic_rd, ke_etv, ke_total, wa_age, wa_last_snap, sw_last_traffic, auction_bids, auction_price, auction_end_time, added_at' - name: sort_desc in: query required: false schema: type: boolean default: true title: Sort Desc - name: page in: query required: false schema: type: integer default: 1 title: Page - name: page_size in: query required: false schema: type: integer default: 10 title: Page Size requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReportListFilterSchema' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportListResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/favorites: get: tags: - Reports summary: List Favorite Reports description: 'List the current user''s favorite reports across all bases. Same response shape as ``POST /search`` with ``favorites: true``. For favorites combined with other filters, use ``POST /search`` and set ``favorites`` in the request body. Requires Pro API key (60 req/min). Agent accounts: 1 credit per call from spendable balance.' operationId: list_favorite_reports_v1_reports_favorites_get security: - Bearer: [] parameters: - name: sort_by in: query required: false schema: enum: - report_type - auction_source - karmascore - karmametric - brandscore - openpagerank - sr_as - sr_bl - sr_rd - sr_traffic - ahrefs_dr - ahrefs_ur - moz_da - moz_ss - moz_bl - moz_rd - majestic_tf - majestic_cf - majestic_ratio - majestic_bl - majestic_rd - ke_etv - ke_total - wa_age - wa_last_snap - sw_last_traffic - auction_bids - auction_price - auction_end_time - added_at type: string description: 'Table column name to sort by. Allowed values: report_type, auction_source, karmascore, karmametric, brandscore, openpagerank, sr_as, sr_bl, sr_rd, sr_traffic, ahrefs_dr, ahrefs_ur, moz_da, moz_ss, moz_bl, moz_rd, majestic_tf, majestic_cf, majestic_ratio, majestic_bl, majestic_rd, ke_etv, ke_total, wa_age, wa_last_snap, sw_last_traffic, auction_bids, auction_price, auction_end_time, added_at' default: added_at title: Sort By description: 'Table column name to sort by. Allowed values: report_type, auction_source, karmascore, karmametric, brandscore, openpagerank, sr_as, sr_bl, sr_rd, sr_traffic, ahrefs_dr, ahrefs_ur, moz_da, moz_ss, moz_bl, moz_rd, majestic_tf, majestic_cf, majestic_ratio, majestic_bl, majestic_rd, ke_etv, ke_total, wa_age, wa_last_snap, sw_last_traffic, auction_bids, auction_price, auction_end_time, added_at' - name: sort_desc in: query required: false schema: type: boolean default: true title: Sort Desc - name: page in: query required: false schema: type: integer default: 1 title: Page - name: page_size in: query required: false schema: type: integer default: 10 title: Page Size responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportListResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} post: tags: - Reports summary: Add Favorite Report description: 'Add a report to the current user''s favorites. Requires Pro API key. Agent accounts: 1 credit per call from spendable balance.' operationId: add_favorite_report_v1_reports_favorites_post security: - Bearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FavoriteReportBody' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MassageResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} delete: tags: - Reports summary: Remove Favorite Report description: 'Remove a report from the current user''s favorites. Requires Pro API key. Agent accounts: 1 credit per call from spendable balance.' operationId: remove_favorite_report_v1_reports_favorites_delete security: - Bearer: [] parameters: - name: report_type in: query required: true schema: enum: - backorder - buynow - auctions - expired type: string description: Report collection type title: Report Type description: Report collection type example: expired - name: report_id in: query required: true schema: type: string description: MongoDB document id of the report title: Report Id description: MongoDB document id of the report example: 507f1f77bcf86cd799439011 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MassageResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/annotations/tags: get: tags: - Reports summary: List Report Annotation Tags description: Distinct annotation tags for the current user (sorted). operationId: list_report_annotation_tags_v1_reports_annotations_tags_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportAnnotationTagsResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: properties: error: type: string example: payment_required accepts: items: type: object type: array description: x402 v2 payment options (packs × networks) extensions: properties: karma: properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: items: properties: plan_id: type: string credits: type: integer price_usdc: type: string type: object type: array costs: additionalProperties: type: integer type: object type: object bazaar: type: object type: object type: object security: - Bearer: [] x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/annotations: get: tags: - Reports summary: Get Report Annotation description: Get note and tags for a single report. operationId: get_report_annotation_v1_reports_annotations_get security: - Bearer: [] parameters: - name: report_type in: query required: true schema: enum: - backorder - buynow - auctions - expired type: string description: Report collection type title: Report Type description: Report collection type example: expired - name: report_id in: query required: true schema: type: string description: MongoDB document id of the report title: Report Id description: MongoDB document id of the report example: 507f1f77bcf86cd799439011 responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/ReportAnnotationSchema' - type: 'null' title: Response Get Report Annotation V1 Reports Annotations Get '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} put: tags: - Reports summary: Set Report Annotation description: 'Set or clear report annotation (note + tags). Pro plan required. Agent: 1 credit.' operationId: set_report_annotation_v1_reports_annotations_put security: - Bearer: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReportAnnotationUpsertSchema' responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/ReportAnnotationSchema' - type: 'null' title: Response Set Report Annotation V1 Reports Annotations Put '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} delete: tags: - Reports summary: Delete Report Annotation description: 'Delete report annotation. Pro plan required. Agent accounts: 1 credit per call.' operationId: delete_report_annotation_v1_reports_annotations_delete security: - Bearer: [] parameters: - name: report_type in: query required: true schema: enum: - backorder - buynow - auctions - expired type: string description: Report collection type title: Report Type description: Report collection type example: expired - name: report_id in: query required: true schema: type: string description: MongoDB document id of the report title: Report Id description: MongoDB document id of the report example: 507f1f77bcf86cd799439011 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MassageResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/share: post: tags: - Reports summary: Create Report Share Link description: 'Create or reuse a guest share link for a bases report. Pro plan required. Agent: 1 credit.' operationId: create_report_share_link_v1_reports_share_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateShareLinkBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ShareLinkResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: properties: error: type: string example: payment_required accepts: items: type: object type: array description: x402 v2 payment options (packs × networks) extensions: properties: karma: properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: items: properties: plan_id: type: string credits: type: integer price_usdc: type: string type: object type: array costs: additionalProperties: type: integer type: object type: object bazaar: type: object type: object type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - Bearer: [] x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/{report_type}/{report_id}/enrich-seo: post: tags: - Reports summary: Enrich Report Seo Public description: Start paid SEO enrich job (Pro/Unlimited). Poll GET /enrich-jobs/{job_id}. operationId: enrich_report_seo_public_v1_reports__report_type___report_id__enrich_seo_post security: - Bearer: [] parameters: - name: report_type in: path required: true schema: enum: - backorder - buynow - auctions - expired type: string title: Report Type - name: report_id in: path required: true schema: type: string title: Report Id - name: auth_token in: cookie required: false schema: type: string title: Auth Token responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EnrichSeoJobCreateResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/enrich-jobs/{job_id}: get: tags: - Reports summary: Get Enrich Seo Job Public description: Poll an SEO enrich job by ID. operationId: get_enrich_seo_job_public_v1_reports_enrich_jobs__job_id__get security: - Bearer: [] parameters: - name: job_id in: path required: true schema: type: string title: Job Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EnrichSeoJobPollResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/by-domain: get: tags: - Reports summary: Lookup Reports By Domain description: 'Find report identifiers by exact domain name in all bases collections. Returns every match (at most one per collection). Empty ``matches`` if the domain is not found. Use percent-encoding for non-ASCII domains in the query. Typical flow: lookup here, then ``GET /report?report_type=&report_id=`` for the full report. Agent accounts: 1 credit per call from spendable balance.' operationId: lookup_reports_by_domain_v1_reports_by_domain_get security: - Bearer: [] parameters: - name: domain in: query required: true schema: type: string description: Exact domain name (percent-encode non-ASCII) title: Domain description: Exact domain name (percent-encode non-ASCII) example: example.com responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DomainReportsLookupResponse' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/check/expired: get: tags: - Reports summary: Check Domain Report description: 'Check whether the report domain is available (drop). Updates the report record. NOTE: report_id is the id of the expired report, not the domain. ``is_expired: true`` means the domain appears free, same as in the web app. Re-check is blocked for 3 hours after the last check. Requires Pro API key. Agent accounts: 1 credit per call from spendable balance.' operationId: check_domain_report_v1_reports_check_expired_get security: - Bearer: [] parameters: - name: report_id in: query required: true schema: type: string description: MongoDB id of the expired report (not the domain name) title: Report Id description: MongoDB id of the expired report (not the domain name) example: 507f1f77bcf86cd799439011 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CheckDomainResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} /v1/reports/report: get: tags: - Reports summary: Get Full Report description: 'Get full report by collection type and MongoDB document id. Agent accounts: 1 credit per call from spendable balance.' operationId: get_full_report_v1_reports_report_get security: - Bearer: [] parameters: - name: report_type in: query required: true schema: enum: - backorder - buynow - auctions - expired type: string description: Report collection type title: Report Type description: Report collection type example: expired - name: report_id in: query required: true schema: type: string description: MongoDB document id of the report title: Report Id description: MongoDB document id of the report example: 507f1f77bcf86cd799439011 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReportFullResponseSchema' '402': description: Payment required — x402 agent credits. Read PAYMENT-REQUIRED header (base64 JSON) and retry same URL with PAYMENT-SIGNATURE and optional X-Karma-Plan-Id. headers: PAYMENT-REQUIRED: description: Base64-encoded x402 PaymentRequired JSON schema: type: string X-Karma-Api-Key: description: Issued api_key on first successful purchase schema: type: string Link: description: Agent skill documentation schema: type: string content: application/json: schema: type: object properties: error: type: string example: payment_required accepts: type: array description: x402 v2 payment options (packs × networks) items: type: object extensions: type: object properties: karma: type: object properties: reason: type: string enum: - first_purchase - top_up retry_same_url: type: boolean plan_id_header: type: string recommended_plan_id: type: string keep_api_key: type: boolean packs: type: array items: type: object properties: plan_id: type: string credits: type: integer price_usdc: type: string costs: type: object additionalProperties: type: integer bazaar: type: object '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-payment-info: price: mode: dynamic currency: USD min: '1.50' max: '20.00' protocols: - x402: {} components: schemas: ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError ReportItem: properties: providers_status: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Providers Status report_id: type: string title: Report Id report_type: type: string title: Report Type report_url: type: string title: Report Url description: Direct link to this report in the Karma.Domains web app. domain: type: string title: Domain domain_tld: anyOf: - type: string - type: 'null' title: Domain Tld added_at: type: integer title: Added At processed: type: boolean title: Processed default: false updated_at: anyOf: - type: integer - type: 'null' title: Updated At checked_at: anyOf: - type: integer - type: boolean - type: 'null' title: Checked At expire_checked_at: anyOf: - type: integer - type: 'null' title: Expire Checked At demo: type: boolean title: Demo default: false favorite: type: boolean title: Favorite description: True when the report is in the current user's favorites; always false for guests. default: false annotation: anyOf: - $ref: '#/components/schemas/ReportAnnotationSchema' - type: 'null' description: User note and tags when present; null for guests or reports without annotations. karmascore: anyOf: - type: integer - type: 'null' title: Karmascore karmametric: anyOf: - type: integer - type: 'null' title: Karmametric brandscore: anyOf: - type: integer - type: 'null' title: Brandscore majestic_tf: anyOf: - type: integer - type: 'null' title: Majestic Tf majestic_cf: anyOf: - type: integer - type: 'null' title: Majestic Cf majestic_ratio: anyOf: - type: number - type: 'null' title: Majestic Ratio majestic_bl: anyOf: - type: integer - type: 'null' title: Majestic Bl majestic_rd: anyOf: - type: integer - type: 'null' title: Majestic Rd moz_da: anyOf: - type: integer - type: 'null' title: Moz Da moz_da_history: anyOf: - items: type: integer type: array - type: 'null' title: Moz Da History moz_ss: anyOf: - type: integer - type: 'null' title: Moz Ss moz_rd: anyOf: - type: integer - type: 'null' title: Moz Rd moz_bl: anyOf: - type: integer - type: 'null' title: Moz Bl ahrefs_dr: anyOf: - type: number - type: 'null' title: Ahrefs Dr ahrefs_ur: anyOf: - type: number - type: 'null' title: Ahrefs Ur sr_as: anyOf: - type: integer - type: 'null' title: Sr As sr_bl: anyOf: - type: integer - type: 'null' title: Sr Bl sr_rd: anyOf: - type: integer - type: 'null' title: Sr Rd sr_traffic: anyOf: - type: integer - type: 'null' title: Sr Traffic sr_sources: anyOf: - additionalProperties: true type: object - type: 'null' title: Sr Sources sr_zones: anyOf: - additionalProperties: true type: object - type: 'null' title: Sr Zones ke_etv: anyOf: - type: integer - type: 'null' title: Ke Etv ke_total: anyOf: - type: integer - type: 'null' title: Ke Total google_index: anyOf: - type: boolean - type: 'null' title: Google Index openpagerank: anyOf: - type: number - type: integer - type: 'null' title: Openpagerank blacklists: anyOf: - type: boolean - type: 'null' title: Blacklists categories: anyOf: - items: {} type: array - type: boolean - type: 'null' title: Categories sw_last_traffic: anyOf: - type: integer - type: 'null' title: Sw Last Traffic sw_visits_history: anyOf: - items: type: integer type: array - type: 'null' title: Sw Visits History sw_last_traffic_date: anyOf: - additionalProperties: true type: object - type: 'null' title: Sw Last Traffic Date sw_country_share: anyOf: - items: {} type: array - type: 'null' title: Sw Country Share sw_sources: anyOf: - additionalProperties: true type: object - type: 'null' title: Sw Sources wa_langs: anyOf: - items: {} type: array - type: 'null' title: Wa Langs wa_server_code: anyOf: - items: {} type: array - type: 'null' title: Wa Server Code wa_age: anyOf: - type: integer - type: 'null' title: Wa Age wa_last_snap: anyOf: - type: integer - type: 'null' title: Wa Last Snap wa_changes: anyOf: - type: integer - type: 'null' title: Wa Changes wa_calender: anyOf: - additionalProperties: true type: object - type: 'null' title: Wa Calender wa_last_title: anyOf: - type: string - type: 'null' title: Wa Last Title wa_last_desc: anyOf: - type: string - type: 'null' title: Wa Last Desc wa_screenshot_snaped_at: anyOf: - type: integer - type: 'null' title: Wa Screenshot Snaped At ai_summary: anyOf: - type: string - type: 'null' title: Ai Summary name_analysis: anyOf: - additionalProperties: true type: object - type: 'null' title: Name Analysis description: 'Domain name analysis: structure, words, types, languages, industries, and meaning. See name_analysis fields.' auctions: anyOf: - items: {} type: array - type: 'null' title: Auctions is_expired: anyOf: - type: boolean - type: 'null' title: Is Expired type: object required: - report_id - report_type - report_url - domain - domain_tld - added_at - majestic_tf - majestic_cf - majestic_ratio - majestic_bl - majestic_rd - categories - wa_langs - wa_server_code title: ReportItem AhrefsData: properties: domain_rating: anyOf: - type: number - type: 'null' title: Domain Rating ahrefs_rank: anyOf: - type: integer - type: 'null' title: Ahrefs Rank url_rating: anyOf: - type: number - type: integer - type: 'null' title: Url Rating type: object title: AhrefsData description: Ahrefs (domain) data model FavoriteReportBody: properties: report_id: type: string title: Report Id report_type: type: string enum: - backorder - buynow - auctions - expired title: Report Type type: object required: - report_id - report_type title: FavoriteReportBody SemrushData: properties: backlinks: anyOf: - additionalProperties: true type: object - type: 'null' title: Backlinks traffic_analytics: anyOf: - additionalProperties: true type: object - type: 'null' title: Traffic Analytics type: object title: SemrushData description: Semrush OAuth API data model CountryFilterItem: properties: country: type: string title: Country description: Country code (e.g., 'US', 'GB', 'DE') share_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Share Min description: Minimum traffic share percentage (0-100) type: object required: - country title: CountryFilterItem description: Single country filter item CombineSEOFilter: properties: combine_authority_min: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Domain Authority minimum (DR/DA/TF/OPR/AS). Supported vendors: ahrefs, moz, majestic, openpagerank, semrush.' combine_authority_max: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Domain Authority maximum (DR/DA/TF/OPR/AS). Supported vendors: ahrefs, moz, majestic, openpagerank, semrush.' combine_backlinks_min: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Backlinks minimum. Supported vendors: moz, majestic, semrush.' combine_backlinks_max: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Backlinks maximum. Supported vendors: moz, majestic, semrush.' combine_refdomains_min: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Referring domains minimum. Supported vendors: moz, majestic, semrush.' combine_refdomains_max: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Referring domains maximum. Supported vendors: moz, majestic, semrush.' combine_traffic_min: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Traffic (visits) minimum. Supported vendors: similarweb, semrush.' combine_traffic_max: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Traffic (visits) maximum. Supported vendors: similarweb, semrush.' combine_keywords: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Keyword phrase filter. Supported vendor: keywordseverywhere.' combine_backlink_url: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Backlink URL phrase filter. Supported vendor: moz.' combine_anchors: anyOf: - $ref: '#/components/schemas/CombineSEOCompactFilter' - type: 'null' description: 'Backlink anchor phrase filter. Supported vendor: moz.' type: object title: CombineSEOFilter description: Combined SEO filter with compact named parameters. EnrichSeoJobCreateResponseSchema: properties: job_id: type: string title: Job Id type: object required: - job_id title: EnrichSeoJobCreateResponseSchema description: Accepted enrich job. KeywordseverywhereData: properties: etv: anyOf: - type: integer - type: 'null' title: Etv total_keywords: anyOf: - type: integer - type: 'null' title: Total Keywords data: anyOf: - items: $ref: '#/components/schemas/KeywordItem' type: array - type: 'null' title: Data type: object title: KeywordseverywhereData description: Keywords data model (from KeywordsEverywhere or similar) CategoryData: properties: categories: items: type: string type: array title: Categories vendor: type: string title: Vendor info_url: type: string title: Info Url type: object required: - categories - vendor - info_url title: CategoryData description: Category data model DomainMetrics: properties: categories: anyOf: - items: $ref: '#/components/schemas/CategoryData' type: array - type: boolean - type: 'null' title: Categories default: false openpagerank: anyOf: - type: number - type: integer - type: boolean - type: 'null' title: Openpagerank default: false majestic: anyOf: - $ref: '#/components/schemas/MajesticData' - type: boolean - type: 'null' title: Majestic moz: anyOf: - $ref: '#/components/schemas/MozData' - type: boolean - type: 'null' title: Moz moz_anchor_profile: anyOf: - additionalProperties: true type: object - type: 'null' title: Moz Anchor Profile ahrefs: anyOf: - $ref: '#/components/schemas/AhrefsData' - type: boolean - type: 'null' title: Ahrefs semrush: anyOf: - $ref: '#/components/schemas/SemrushData' - type: boolean - type: 'null' title: Semrush keywordseverywhere: anyOf: - $ref: '#/components/schemas/KeywordseverywhereData' - type: boolean - type: 'null' title: Keywordseverywhere similarweb: anyOf: - $ref: '#/components/schemas/SimilarWebData' - type: boolean - type: 'null' title: Similarweb brandscore: anyOf: - $ref: '#/components/schemas/BrandscoreData' - type: boolean - type: 'null' title: Brandscore karma_metric: anyOf: - $ref: '#/components/schemas/KarmaMetricData' - type: boolean - type: 'null' title: Karma Metric ai_summary: anyOf: - type: string - type: 'null' title: Ai Summary google: anyOf: - $ref: '#/components/schemas/GoogleData' - type: boolean - type: 'null' title: Google blacklists: anyOf: - items: $ref: '#/components/schemas/BlacklistsData' type: array - type: boolean - type: 'null' title: Blacklists default: false checked_services: anyOf: - items: type: string type: array - type: 'null' title: Checked Services type: object title: DomainMetrics description: Domain metrics data model BrandscoreData: properties: pronounceability: type: integer title: Pronounceability memorability: type: integer title: Memorability uniqueness: type: integer title: Uniqueness appeal: type: integer title: Appeal brandscore: type: integer title: Brandscore type: object required: - pronounceability - memorability - uniqueness - appeal - brandscore title: BrandscoreData description: Brandscore data model KeywordItem: properties: position: anyOf: - type: integer - type: 'null' title: Position etv: anyOf: - type: integer - type: 'null' title: Etv keyword: anyOf: - type: string - type: 'null' title: Keyword type: object title: KeywordItem description: Individual keyword data model LanguageFilterItem: properties: language: type: string title: Language description: Language code (e.g., 'en', 'ru', 'de') ratio_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Ratio Min description: Minimum percentage (0-100) type: object required: - language title: LanguageFilterItem description: Single language filter item ReportFullResponseSchema: properties: providers_status: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Providers Status report_type: type: string title: Report Type favorite: type: boolean title: Favorite default: false annotation: anyOf: - $ref: '#/components/schemas/ReportAnnotationData' - type: 'null' demo: type: boolean title: Demo default: false guest_view: type: boolean title: Guest View default: false is_expired: anyOf: - type: boolean - type: 'null' title: Is Expired processed: type: boolean title: Processed default: false added_at: type: integer title: Added At updated_at: anyOf: - type: integer - type: 'null' title: Updated At created_at: title: Created At checked_at: anyOf: - type: integer - type: 'null' title: Checked At expire_checked_at: anyOf: - type: integer - type: 'null' title: Expire Checked At web_archive: anyOf: - additionalProperties: true type: object - type: 'null' title: Web Archive metrics: anyOf: - $ref: '#/components/schemas/DomainMetrics' - type: 'null' domain: type: string title: Domain domain_tld: type: string title: Domain Tld domain_length: type: integer title: Domain Length domain_numbers: type: boolean title: Domain Numbers domain_hyphens: type: boolean title: Domain Hyphens name_analysis: anyOf: - additionalProperties: true type: object - type: 'null' title: Name Analysis description: 'Domain name analysis: structure, words, types, languages, industries, and meaning. See name_analysis fields.' auctions: anyOf: - additionalProperties: true type: object - type: 'null' title: Auctions task: anyOf: - additionalProperties: true type: object - type: 'null' title: Task report_id: type: string title: Report Id enrich_seo: anyOf: - $ref: '#/components/schemas/EnrichSeoHintSchema' - type: 'null' type: object required: - report_type - added_at - domain - domain_tld - domain_length - domain_numbers - domain_hyphens - report_id title: ReportFullResponseSchema description: Report full response schema Engagements: properties: BounceRate: anyOf: - type: number - type: 'null' title: Bouncerate Month: anyOf: - type: string - type: 'null' title: Month Year: anyOf: - type: string - type: 'null' title: Year PagePerVisit: anyOf: - type: number - type: 'null' title: Pagepervisit Visits: anyOf: - type: number - type: 'null' title: Visits TimeOnSite: anyOf: - type: number - type: 'null' title: Timeonsite type: object title: Engagements description: SimilarWeb engagements data model CombineSEOCompactFilter: properties: vl: anyOf: - type: number - type: integer - type: string - type: 'null' title: Vl description: Compact value for one named combine parameter. vn: anyOf: - items: type: string enum: - ahrefs - moz - majestic - openpagerank - similarweb - semrush - keywordseverywhere type: array - type: 'null' title: Vn description: Compact vendor list for one named combine parameter. If omitted/null, backend uses all vendors for this parameter. type: object title: CombineSEOCompactFilter description: Compact combined SEO field filter. ReportListResponseSchema: properties: report_list: items: $ref: '#/components/schemas/ReportItem' type: array title: Report List total_count: type: integer title: Total Count type: object required: - report_list - total_count title: ReportListResponseSchema description: Report list response schema ReportListFilterSchema: properties: combine_seo: anyOf: - $ref: '#/components/schemas/CombineSEOFilter' - type: 'null' description: Combined SEO filter. OR logic inside each group by selected vendors; groups are combined with AND. favorites: anyOf: - type: boolean - type: 'null' title: Favorites description: Filter by favorites. True = show only favorite reports, False = exclude favorites. Requires user_id to be provided. has_annotations: anyOf: - type: boolean - type: 'null' title: Has Annotations description: Filter by report annotations. True = only reports with a note or tags, False = exclude annotated reports. Pro only. report_tags: anyOf: - items: type: string type: array - type: 'null' title: Report Tags description: Filter by annotation tags (AND logic — report must contain all selected tags). Pro only. tlds: anyOf: - type: string maxLength: 350 - type: 'null' title: Tlds description: List of TLD's separated by comma or space domain: anyOf: - type: string maxLength: 350 - type: 'null' title: Domain description: Domain Name. Use comma (,) for AND logic (all domains must match) or pipe (|) for OR logic (any domain matches). Case-insensitive substring search. categories: anyOf: - items: type: string type: array - type: 'null' title: Categories description: List of categories. Each category will be searched with OR logic (any category matches). Use exact flat category names. Case-insensitive substring search. categories_exclude: anyOf: - items: type: string type: array - type: 'null' title: Categories Exclude description: Categories to exclude. OR logic — domain is excluded if it has ANY listed category. Use exact flat category names. Case-insensitive substring search. domain_type: anyOf: - items: type: string enum: - auctions - backorder - buynow - expired type: array - type: 'null' title: Domain Type description: 'Filter by domain base type: auctions, backorder, buynow, or expired. OR logic (any selected type matches).' languages: anyOf: - type: string maxLength: 350 - type: 'null' title: Languages description: List of languages. Use comma (,) for AND logic (all languages must match) or pipe (|) for OR logic (any language matches). Case-insensitive substring search. keywords: anyOf: - type: string maxLength: 350 - type: 'null' title: Keywords description: Keywords to search in web archive content (title, description, h1-h6, etc.). Use comma (,) for AND logic (all keywords must be found) or pipe (|) for OR logic (any keyword found). openpagerank_min: anyOf: - type: integer - type: 'null' title: Openpagerank Min description: Openpagerank (OPR) Min (0-10) openpagerank_max: anyOf: - type: integer - type: 'null' title: Openpagerank Max description: Openpagerank (OPR) Max (0-10) domain_numbers: anyOf: - type: boolean - type: 'null' title: Domain Numbers description: Domain Name has Numbers (True/False) domain_hyphens: anyOf: - type: boolean - type: 'null' title: Domain Hyphens description: Domain Name has Hyphens (True/False) domain_length_min: anyOf: - type: integer - type: 'null' title: Domain Length Min description: Domain Name Length Min (1-30) domain_length_max: anyOf: - type: integer - type: 'null' title: Domain Length Max description: Domain Name Length Max (1-30) majestic_tf_min: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Majestic Tf Min description: Majestic Trust Flow (TF) Min (0-100) majestic_tf_max: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Majestic Tf Max description: Majestic Trust Flow (TF) Max (0-100) majestic_cf_min: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Majestic Cf Min description: Majestic Citation Flow (CF) Min (0-100) majestic_cf_max: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Majestic Cf Max description: Majestic Citation Flow (CF) Max (0-100) majestic_ratio_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Majestic Ratio Min description: Majestic Ratio (TF/CF) Min. Two decimals, empty when CF is 0. majestic_ratio_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Majestic Ratio Max description: Majestic Ratio (TF/CF) Max. Two decimals, empty when CF is 0. majestic_bl_min: anyOf: - type: integer - type: 'null' title: Majestic Bl Min description: Majestic Backlinks (BL) Min majestic_bl_max: anyOf: - type: integer - type: 'null' title: Majestic Bl Max description: Majestic Backlinks (BL) Max majestic_rd_min: anyOf: - type: integer - type: 'null' title: Majestic Rd Min description: Majestic Referring Domains (RD) Min majestic_rd_max: anyOf: - type: integer - type: 'null' title: Majestic Rd Max description: Majestic Referring Domains (RD) Max wa_age_min: anyOf: - type: integer - type: 'null' title: Wa Age Min description: Domain age in years (Min) by Wayback Machine wa_age_max: anyOf: - type: integer - type: 'null' title: Wa Age Max description: Domain age in years (Max) by Wayback Machine wa_first_snap: anyOf: - items: type: string type: array - type: 'null' title: Wa First Snap description: 'Wayback Machine first snap date range. Array of 2 strings: [start_date, end_date]. Format: ''YYYY-MM-DD'' (e.g., [''2020-01-01'', ''2023-12-31'']). Time is automatically set to 00:00:00 for start and 23:59:59 for end.' wa_last_snap: anyOf: - items: type: string type: array - type: 'null' title: Wa Last Snap description: 'Wayback Machine last snap date range. Array of 2 strings: [start_date, end_date]. Format: ''YYYY-MM-DD'' (e.g., [''2020-01-01'', ''2023-12-31'']). Time is automatically set to 00:00:00 for start and 23:59:59 for end.' karmascore_min: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Karmascore Min description: KarmaScore Min (0-100) karmascore_max: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Karmascore Max description: KarmaScore Max (0-100) wa_hieroglyphs: anyOf: - type: boolean - type: 'null' title: Wa Hieroglyphs description: Content has Hieroglyphs (Asian Content) in Wayback Machine (True/False) wa_redirects: anyOf: - type: boolean - type: 'null' title: Wa Redirects description: Content has redirects in Wayback Machine. True = has redirects (HTTP codes 301, 302, 307, 308), False = no redirects. wa_error403: anyOf: - type: boolean - type: 'null' title: Wa Error403 description: Content has HTTP error code 403 (Forbidden) in Wayback Machine. True = has 403 errors, False = no 403 errors. wa_changes_min: anyOf: - type: integer - type: 'null' title: Wa Changes Min description: Minimum number of content changes in Wayback Machine history wa_changes_max: anyOf: - type: integer - type: 'null' title: Wa Changes Max description: Maximum number of content changes in Wayback Machine history wa_parkings_min: anyOf: - type: integer - type: 'null' title: Wa Parkings Min description: Minimum number of parking pages in Wayback Machine history wa_parkings_max: anyOf: - type: integer - type: 'null' title: Wa Parkings Max description: Maximum number of parking pages in Wayback Machine history wa_redirects_min: anyOf: - type: integer - type: 'null' title: Wa Redirects Min description: Minimum number of redirects in Wayback Machine history wa_redirects_max: anyOf: - type: integer - type: 'null' title: Wa Redirects Max description: Maximum number of redirects in Wayback Machine history wa_lang_filters: anyOf: - items: $ref: '#/components/schemas/LanguageFilterItem' type: array - type: 'null' title: Wa Lang Filters description: 'List of language filters with optional minimum percentage. Each filter: {''language'': ''en'', ''ratio_min'': 30} or {''language'': ''ru''}. OR logic - matches any language.' wa_server_code: anyOf: - type: integer - type: 'null' title: Wa Server Code description: HTTP server response code in Wayback Machine (e.g., 200, 301, 302, 403, 404). Used together with wa_server_code_ratio_min/max. Filters by server_code field. wa_server_code_ratio_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Wa Server Code Ratio Min description: Server Code Ratio in Wayback Machine Min (0-100) wa_server_code_ratio_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Wa Server Code Ratio Max description: Server Code Ratio in Wayback Machine Max (0-100) sw_visits_min: anyOf: - type: integer - type: 'null' title: Sw Visits Min description: Similarweb Visits Min sw_visits_max: anyOf: - type: integer - type: 'null' title: Sw Visits Max description: Similarweb Visits Max sw_ts_social_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Social Min description: Similarweb Traffic Sources Social Ratio Min (0-100) sw_ts_social_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Social Max description: Similarweb Traffic Sources Social Ratio Max (0-100) sw_ts_paid_referrals_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Paid Referrals Min description: Similarweb Traffic Sources Paid Referrals Ratio Min (0-100) sw_ts_paid_referrals_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Paid Referrals Max description: Similarweb Traffic Sources Paid Referrals Ratio Max (0-100) sw_ts_mail_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Mail Min description: Similarweb Traffic Sources Mail Ratio Min (0-100) sw_ts_mail_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Mail Max description: Similarweb Traffic Sources Mail Ratio Max (0-100) sw_ts_referrals_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Referrals Min description: Similarweb Traffic Sources Referrals Ratio Min (0-100) sw_ts_referrals_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Referrals Max description: Similarweb Traffic Sources Referrals Ratio Max (0-100) sw_ts_search_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Search Min description: Similarweb Traffic Sources Search Ratio Min (0-100) sw_ts_search_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Search Max description: Similarweb Traffic Sources Search Ratio Max (0-100) sw_ts_direct_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Direct Min description: Similarweb Traffic Sources Direct Ratio Min (0-100) sw_ts_direct_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Ts Direct Max description: Similarweb Traffic Sources Direct Ratio Max (0-100) sw_country_filters: anyOf: - items: $ref: '#/components/schemas/CountryFilterItem' type: array - type: 'null' title: Sw Country Filters description: 'List of country filters with optional minimum traffic share. Each filter: {''country'': ''US'', ''share_min'': 50} or {''country'': ''GB''}. OR logic - matches any country.' sw_country_share_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Country Share Min description: Similarweb Country Share Ratio Min (0-100) sw_country_share_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sw Country Share Max description: Similarweb Country Share Ratio Max (0-100) sw_last_traffic_date: anyOf: - items: type: string type: array - type: 'null' title: Sw Last Traffic Date description: 'Similarweb last traffic date range. Array of 2 strings: [start_date, end_date]. Format: ''YYYY-MM'' (e.g., [''2023-01'', ''2023-12'']). Filters by Year and Month fields.' moz_da_min: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Moz Da Min description: Moz Domain Authority (DA) Min moz_da_max: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Moz Da Max description: Moz Domain Authority (DA) Max moz_ss_min: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Moz Ss Min description: Moz Spam Score (SS) Min (0-100) moz_ss_max: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Moz Ss Max description: Moz Spam Score (SS) Max (0-100) moz_bl_min: anyOf: - type: integer - type: 'null' title: Moz Bl Min description: Moz Backlinks (External Pages) Min moz_bl_max: anyOf: - type: integer - type: 'null' title: Moz Bl Max description: Moz Backlinks (External Pages) Max moz_rd_min: anyOf: - type: integer - type: 'null' title: Moz Rd Min description: Moz Referring Domains (RD) Min moz_rd_max: anyOf: - type: integer - type: 'null' title: Moz Rd Max description: Moz Referring Domains (RD) Max moz_bl_url: anyOf: - type: string maxLength: 350 - type: 'null' title: Moz Bl Url description: Moz backlink URL source(s). Use comma (,) for AND logic (all URLs must be found) or pipe (|) for OR logic (any URL found). Case-insensitive phrase matching. moz_bl_anchor: anyOf: - type: string maxLength: 350 - type: 'null' title: Moz Bl Anchor description: Moz backlink anchor text(s). Use comma (,) for AND logic (all anchors must be found) or pipe (|) for OR logic (any anchor found). Case-insensitive phrase matching. ahrefs_dr_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Ahrefs Dr Min description: Ahrefs Domain Rating (DR) Min (0-100) ahrefs_dr_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Ahrefs Dr Max description: Ahrefs Domain Rating (DR) Max (0-100) ahrefs_ur_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Ahrefs Ur Min description: Ahrefs URL Rating (UR) Min (0-100) ahrefs_ur_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Ahrefs Ur Max description: Ahrefs URL Rating (UR) Max (0-100) ahrefs_ar_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Ahrefs Ar Min description: Ahrefs Rank (AR) Min (lower rank = stronger domain) ahrefs_ar_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Ahrefs Ar Max description: Ahrefs Rank (AR) Max sr_as_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sr As Min description: Semrush Authority Score (AS) Min (0-100) sr_as_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sr As Max description: Semrush Authority Score (AS) Max (0-100) sr_bl_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Bl Min description: Semrush Backlinks Min sr_bl_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Bl Max description: Semrush Backlinks Max sr_rd_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Rd Min description: Semrush Referring Domains Min sr_rd_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Rd Max description: Semrush Referring Domains Max sr_ip_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Ip Min description: Semrush Referring IPs Min sr_ip_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Ip Max description: Semrush Referring IPs Max sr_edu_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Edu Min description: Semrush EDU Backlinks Min sr_edu_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Edu Max description: Semrush EDU Backlinks Max sr_gov_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Gov Min description: Semrush GOV Backlinks Min sr_gov_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Gov Max description: Semrush GOV Backlinks Max sr_visits_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Visits Min description: Semrush Visits Min sr_visits_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Visits Max description: Semrush Visits Max sr_users_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Users Min description: Semrush Unique Visitors Min sr_users_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Users Max description: Semrush Unique Visitors Max sr_desktop_share_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sr Desktop Share Min description: Semrush Desktop Share Min (0-100%) sr_desktop_share_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sr Desktop Share Max description: Semrush Desktop Share Max (0-100%) sr_mobile_share_min: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sr Mobile Share Min description: Semrush Mobile Share Min (0-100%) sr_mobile_share_max: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Sr Mobile Share Max description: Semrush Mobile Share Max (0-100%) sr_direct_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Direct Min description: Semrush Traffic Direct Min sr_direct_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Direct Max description: Semrush Traffic Direct Max sr_search_organic_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Search Organic Min description: Semrush Traffic Search Organic Min sr_search_organic_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Search Organic Max description: Semrush Traffic Search Organic Max sr_search_paid_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Search Paid Min description: Semrush Traffic Search Paid Min sr_search_paid_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Search Paid Max description: Semrush Traffic Search Paid Max sr_referral_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Referral Min description: Semrush Traffic Referral Min sr_referral_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Referral Max description: Semrush Traffic Referral Max sr_social_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Social Min description: Semrush Traffic Social Min sr_social_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Social Max description: Semrush Traffic Social Max sr_mail_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Mail Min description: Semrush Traffic Mail Min sr_mail_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Sr Mail Max description: Semrush Traffic Mail Max ke_etv_min: anyOf: - type: integer - type: 'null' title: Ke Etv Min description: KeywordsEverywhere Estimated Traffic Value (ETV) Min ke_etv_max: anyOf: - type: integer - type: 'null' title: Ke Etv Max description: KeywordsEverywhere Estimated Traffic Value (ETV) Max ke_total_min: anyOf: - type: integer - type: 'null' title: Ke Total Min description: KeywordsEverywhere Total Keywords Min ke_total_max: anyOf: - type: integer - type: 'null' title: Ke Total Max description: KeywordsEverywhere Total Keywords Max ke_keyword: anyOf: - type: string maxLength: 350 - type: 'null' title: Ke Keyword description: KeywordsEverywhere keyword(s). Use comma (,) for AND logic (all keywords must be found) or pipe (|) for OR logic (any keyword found). Case-insensitive phrase matching. google_title_index: anyOf: - type: string maxLength: 350 - type: 'null' title: Google Title Index description: Search in the Google snippet title when requesting site:domain.tld (domain's pages in Google index). Use comma (,) for AND or pipe (|) for OR. Case-insensitive. google_title_mentions: anyOf: - type: string maxLength: 350 - type: 'null' title: Google Title Mentions description: Search in the Google snippet title when requesting "domain.tld" (mentions). Use comma (,) for AND or pipe (|) for OR. Case-insensitive. google_description_index: anyOf: - type: string maxLength: 350 - type: 'null' title: Google Description Index description: Search in the Google snippet description when requesting site:domain.tld (domain's pages in Google index). Use comma (,) for AND or pipe (|) for OR. Case-insensitive. google_description_mentions: anyOf: - type: string maxLength: 350 - type: 'null' title: Google Description Mentions description: Search in the Google snippet description when requesting "domain.tld" (mentions). Use comma (,) for AND or pipe (|) for OR. Case-insensitive. google_has_index: anyOf: - type: boolean - type: 'null' title: Google Has Index description: At least one Google result for site:domain.tld (domain's pages in Google index). True/False. None = any. google_has_mentions: anyOf: - type: boolean - type: 'null' title: Google Has Mentions description: At least one Google result for "domain.tld" (sites that mention the domain). True/False. None = any. brandscore_min: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Brandscore Min description: 'Brandscore Min (0-100). Brandscore is the domain brandiness indicator: higher value = more brand-like, brandable (brand-worthy, suitable for a brand).' brandscore_max: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Brandscore Max description: 'Brandscore Max (0-100). Brandscore is the domain brandiness indicator: higher value = more brand-like, brandable (brand-worthy, suitable for a brand).' karmametric_min: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Karmametric Min description: Karma Metric Min (0-100) karmametric_max: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Karmametric Max description: Karma Metric Max (0-100) auction_source: anyOf: - items: type: string type: array - type: 'null' title: Auction Source description: Auction source(s). Each item can be a source name or 'source|sale_type' format (e.g., ['godaddy', 'namejet|buynow']). Case-insensitive matching. Items are combined with OR logic. auction_end_time: anyOf: - items: {} type: array - type: 'null' title: Auction End Time description: 'Auction end time date range. Array of 2 strings: [start_date, end_date]. Format: ''YYYY-MM-DD'' (e.g., [''2024-01-01'', ''2024-12-31'']). For ''auctions'' report type, only shows active auctions (end_time >= now).' auction_added_time: anyOf: - items: {} type: array - type: 'null' title: Auction Added Time description: 'Auction added time date range. Array of 2 strings: [start_date, end_date]. Format: ''YYYY-MM-DD'' (e.g., [''2024-01-01'', ''2024-12-31'']). For ''auctions'' report type, only shows domains with active auctions.' report_added_time: anyOf: - items: type: string type: array - type: 'null' title: Report Added Time description: 'Report added date range. Array of 2 strings: [start_date, end_date]. Format: ''YYYY-MM-DD'' (e.g., [''2020-01-01'', ''2023-12-31'']). Time is automatically set to 00:00:00 for start and 23:59:59 for end. Filters by added_at field.' auction_price_min: anyOf: - type: number - type: 'null' title: Auction Price Min description: Auction Price Min (USD/EUR) auction_price_max: anyOf: - type: number - type: 'null' title: Auction Price Max description: Auction Price Max (USD/EUR) auction_bids_min: anyOf: - type: integer - type: 'null' title: Auction Bids Min description: Auction Bids Min (Number of bids) auction_bids_max: anyOf: - type: integer - type: 'null' title: Auction Bids Max description: Auction Bids Max (Number of bids) website_ids: anyOf: - items: type: string type: array - type: 'null' title: Website Ids description: List of website service IDs (e.g., Google Analytics ID, Yandex Metrika ID). OR logic - finds domains with ANY of the specified IDs. Used to find domains owned by the same owner. name_starts: anyOf: - type: string maxLength: 256 - type: 'null' title: Name Starts description: 'Second-level name starts with this sequence. Several alternatives separated by a space or | always use OR. A hyphen stays inside one value. Case-insensitive. Example: car auto.' name_ends: anyOf: - type: string maxLength: 256 - type: 'null' title: Name Ends description: 'Second-level name ends with this sequence. Several alternatives separated by a space or | always use OR. A hyphen stays inside one value. Case-insensitive. Example: shop store.' ln_pattern: anyOf: - items: type: string type: array - type: 'null' title: Ln Pattern description: 'Letter/digit patterns of the second-level name. OR logic. L=letter, N=digit, H=hyphen, X=other. Example: LLLL, LLNN.' cv_pattern: anyOf: - items: type: string type: array - type: 'null' title: Cv Pattern description: 'Vowel/consonant patterns of the second-level name. OR logic. V=aeiouy, C=other Latin letter, N=digit, H=hyphen, X=other. Example: CVCV.' digit_count_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Digit Count Min description: Minimum number of digits in the second-level name. digit_count_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Digit Count Max description: Maximum number of digits in the second-level name. hyphen_count_min: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Hyphen Count Min description: Minimum number of hyphens in the second-level name. hyphen_count_max: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Hyphen Count Max description: Maximum number of hyphens in the second-level name. name_word_count_min: anyOf: - type: integer maximum: 8.0 minimum: 1.0 - type: 'null' title: Name Word Count Min description: Minimum number of classified words in the name. name_word_count_max: anyOf: - type: integer maximum: 8.0 minimum: 1.0 - type: 'null' title: Name Word Count Max description: Maximum number of classified words in the name. name_types: anyOf: - items: type: string type: array - type: 'null' title: Name Types description: Name types from settings/name_analysis.json. OR logic. A domain matches if any selected type is present. name_languages: anyOf: - items: type: string type: array - type: 'null' title: Name Languages description: Detected name language codes. OR logic. name_token: anyOf: - type: string maxLength: 64 - type: 'null' title: Name Token description: Exact classified token anywhere in the name. Case-insensitive. name_industries: anyOf: - items: type: string type: array - type: 'null' title: Name Industries description: Industry ids from settings/name_analysis.json. OR logic. name_first_token: anyOf: - type: string maxLength: 256 - type: 'null' title: Name First Token description: 'Exact first classified token. Several alternatives separated by | use OR. Case-insensitive. Example: blog|shop.' name_last_token: anyOf: - type: string maxLength: 256 - type: 'null' title: Name Last Token description: 'Exact last classified token. Several alternatives separated by | use OR. Case-insensitive. Example: blog|shop.' name_confidence_min: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Name Confidence Min description: Minimum overall name-classification confidence, from 0 to 1. name_status: anyOf: - type: string enum: - completed - failed - type: 'null' title: Name Status description: Name analysis state. Absent analysis is not completed and not failed. type: object title: ReportListFilterSchema ReportAnnotationUpsertSchema: properties: report_id: type: string title: Report Id report_type: type: string title: Report Type note: type: string maxLength: 200 title: Note default: '' tags: items: type: string type: array maxItems: 10 title: Tags type: object required: - report_id - report_type title: ReportAnnotationUpsertSchema description: Upsert report annotation request. KarmaMetricData: properties: karma_metric: type: integer maximum: 100.0 minimum: 0.0 title: Karma Metric description: Final metric score (0-100) components: $ref: '#/components/schemas/KarmaMetricComponents' description: Score components period: anyOf: - type: string pattern: ^\d{4}-\d{2}$ - type: 'null' title: Period description: Period YYYY-MM type: object required: - karma_metric - components title: KarmaMetricData description: Karma metric data model ShareLinkResponseSchema: properties: token: type: string title: Token expires_at: type: integer title: Expires At share_url: type: string title: Share Url type: object required: - token - expires_at - share_url title: ShareLinkResponseSchema description: Guest share link metadata with ready-to-send URL (Public API / MCP). DomainReportMatch: properties: report_id: type: string title: Report Id report_type: type: string title: Report Type domain: type: string title: Domain added_at: anyOf: - type: integer - type: 'null' title: Added At type: object required: - report_id - report_type - domain title: DomainReportMatch description: Report reference found by exact domain match in one bases collection. EnrichSeoJobResultSchema: properties: charged: type: boolean title: Charged default: false updated_services: items: type: string type: array title: Updated Services domain: anyOf: - type: string - type: 'null' title: Domain had_errors: type: boolean title: Had Errors default: false type: object title: EnrichSeoJobResultSchema BlacklistsData: properties: info_url: type: string title: Info Url vendor: type: string title: Vendor info: anyOf: - type: string - type: 'null' title: Info type: object required: - info_url - vendor title: BlacklistsData description: Blacklists data model MozBacklink: properties: domain_source: anyOf: - type: string - type: 'null' title: Domain Source url_source: anyOf: - type: string - type: 'null' title: Url Source domain_target: anyOf: - type: string - type: 'null' title: Domain Target url_target: anyOf: - type: string - type: 'null' title: Url Target anchor_text: anyOf: - type: string - type: 'null' title: Anchor Text harmonic_centrality: anyOf: - type: integer - type: 'null' title: Harmonic Centrality last_found_date: anyOf: - type: string - type: 'null' title: Last Found Date type: object title: MozBacklink description: Moz backlink data model DomainReportsLookupResponse: properties: domain: type: string title: Domain matches: items: $ref: '#/components/schemas/DomainReportMatch' type: array title: Matches type: object required: - domain title: DomainReportsLookupResponse description: 'All bases reports matching a normalized domain (up to one per collection). Uses BaseModel (not APISchema) so empty ``matches`` stays ``[]`` — APISchema.check_empty would turn ``[]`` into ``None`` and fail list validation.' EnrichSeoHintSchema: properties: available: type: boolean title: Available default: false missing: items: type: string type: array title: Missing cost: type: integer title: Cost default: 3 type: object title: EnrichSeoHintSchema description: Whether paid SEO enrich is available for this report. MajesticData: properties: tf: anyOf: - type: integer - type: 'null' title: Tf cf: anyOf: - type: integer - type: 'null' title: Cf backlinks: anyOf: - type: integer - type: 'null' title: Backlinks refdomains: anyOf: - type: integer - type: 'null' title: Refdomains primary_topic: anyOf: - type: string - type: 'null' title: Primary Topic topics: anyOf: - items: {} type: array - type: 'null' title: Topics anchor_lang: anyOf: - items: {} type: array - type: 'null' title: Anchor Lang indexed_urls: anyOf: - type: integer - type: 'null' title: Indexed Urls referring_ips: anyOf: - type: integer - type: 'null' title: Referring Ips referring_subnets: anyOf: - type: integer - type: 'null' title: Referring Subnets ratio: anyOf: - type: number - type: 'null' title: Ratio type: object title: MajesticData description: Majestic data model GoogleData: properties: google_index: anyOf: - items: $ref: '#/components/schemas/GoogleItem' type: array - type: 'null' title: Google Index google_mentions: anyOf: - items: $ref: '#/components/schemas/GoogleItem' type: array - type: 'null' title: Google Mentions type: object title: GoogleData description: Google data model CheckDomainResponseSchema: properties: timestamp: type: integer title: Timestamp is_expired: type: boolean title: Is Expired type: object required: - timestamp - is_expired title: CheckDomainResponseSchema description: Check domain response schema EnrichSeoJobPollResponseSchema: properties: status: type: string enum: - pending - done - failed title: Status progress: anyOf: - additionalProperties: true type: object - type: 'null' title: Progress result: anyOf: - $ref: '#/components/schemas/EnrichSeoJobResultSchema' - type: 'null' error: anyOf: - type: string - type: 'null' title: Error type: object required: - status title: EnrichSeoJobPollResponseSchema CountryShare: properties: Country: anyOf: - type: integer - type: 'null' title: Country CountryCode: anyOf: - type: string - type: 'null' title: Countrycode Value: anyOf: - type: number - type: 'null' title: Value type: object title: CountryShare description: SimilarWeb country share data model CreateShareLinkBody: properties: report_type: type: string title: Report Type report_id: type: string title: Report Id type: object required: - report_type - report_id title: CreateShareLinkBody description: Create a guest share link for a bases report (Pro only). HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError MozData: properties: page_rank: anyOf: - type: number - type: 'null' title: Page Rank moz_domain_authority: anyOf: - type: integer - type: 'null' title: Moz Domain Authority moz_spam_score: anyOf: - type: integer - type: 'null' title: Moz Spam Score moz_link_propensity: anyOf: - type: integer - type: 'null' title: Moz Link Propensity moz_pages_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz Pages To Subdomain moz_nofollow_pages_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz Nofollow Pages To Subdomain moz_redirect_pages_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz Redirect Pages To Subdomain moz_external_pages_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz External Pages To Subdomain moz_external_nofollow_pages_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz External Nofollow Pages To Subdomain moz_external_redirect_pages_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz External Redirect Pages To Subdomain moz_deleted_pages_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz Deleted Pages To Subdomain moz_root_domains_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz Root Domains To Subdomain moz_deleted_root_domains_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz Deleted Root Domains To Subdomain moz_nofollow_root_domains_to_subdomain: anyOf: - type: integer - type: 'null' title: Moz Nofollow Root Domains To Subdomain moz_da_history_values: anyOf: - type: string - type: 'null' title: Moz Da History Values backlinks: anyOf: - items: $ref: '#/components/schemas/MozBacklink' type: array - type: 'null' title: Backlinks type: object title: MozData description: Moz data model ReportAnnotationData: properties: note: type: string title: Note default: '' tags: items: type: string type: array title: Tags default: [] type: object title: ReportAnnotationData description: User note and tags attached to a report. TrafficSources: properties: Social: anyOf: - type: number - type: 'null' title: Social Paid Referrals: anyOf: - type: number - type: 'null' title: Paid Referrals Mail: anyOf: - type: number - type: 'null' title: Mail Referrals: anyOf: - type: number - type: 'null' title: Referrals Search: anyOf: - type: number - type: 'null' title: Search Direct: anyOf: - type: number - type: 'null' title: Direct type: object title: TrafficSources description: SimilarWeb traffic sources data model MassageResponseSchema: properties: status: type: string title: Status message: type: string title: Message type: object required: - status - message title: MassageResponseSchema description: Massage response schema SimilarWebData: properties: engagments: anyOf: - $ref: '#/components/schemas/Engagements' - type: 'null' estimated_monthly_visits: anyOf: - additionalProperties: type: integer type: object - type: 'null' title: Estimated Monthly Visits traffic_sources: anyOf: - $ref: '#/components/schemas/TrafficSources' - type: 'null' category: anyOf: - type: string - type: 'null' title: Category top_country_shares: anyOf: - items: $ref: '#/components/schemas/CountryShare' type: array - type: 'null' title: Top Country Shares type: object title: SimilarWebData description: SimilarWeb data model ReportAnnotationSchema: properties: note: type: string maxLength: 200 title: Note default: '' tags: items: type: string type: array maxItems: 10 title: Tags type: object title: ReportAnnotationSchema description: Report annotation payload. KarmaMetricComponents: properties: A_mass: type: integer maximum: 100.0 minimum: 0.0 title: A Mass description: Mass component (0-100) A_cont: type: integer maximum: 100.0 minimum: 0.0 title: A Cont description: Continuity component (0-100) A_stab: type: integer maximum: 100.0 minimum: 0.0 title: A Stab description: Stability component (0-100) A_trend: type: integer maximum: 100.0 minimum: 0.0 title: A Trend description: Trend component (0-100) A_hist: type: integer maximum: 100.0 minimum: 0.0 title: A Hist description: Long-term history component (0-100) default: 0 type: object required: - A_mass - A_cont - A_stab - A_trend title: KarmaMetricComponents description: Karma metric components model ReportAnnotationTagsResponseSchema: properties: tags: items: type: string type: array title: Tags type: object title: ReportAnnotationTagsResponseSchema description: Distinct annotation tags for the current user. GoogleItem: properties: rank: type: integer title: Rank url: type: string title: Url title: anyOf: - type: string - type: 'null' title: Title description: anyOf: - type: string - type: 'null' title: Description type: object required: - rank - url title: GoogleItem description: Google item data model securitySchemes: Bearer: type: http description: API key as Bearer token, or x402 PAYMENT-SIGNATURE for agent credits scheme: bearer