Skip to content
HALOWERK

Signalwerk

offer gap hints

Per site the start page and, when linked, one payment page and one shipping page are read (robots.txt respected, at most 3 fetches per domain) or supplied as HTML with extra_pages. Languages: html lang, hreflang alternates and language switchers (BCP 47 primary subtag, checked against CLDR). Payment methods: 26 methods (PayPal, Klarna, invoice, SEPA direct debit, cards, Apple/Google/Amazon Pay, prepayment, iDEAL, Bancontact, eps, Przelewy24, TWINT, PostFinance, Billie, Mondu ) from logo alt.

POST https://signal.halowerk.com/v1/offer-gap-hints

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
subjectobjectYes
competitorsarrayYes
dimensionsarrayNo
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "subject",
    "competitors"
  ],
  "properties": {
    "subject": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "label": {
          "type": "string",
          "maxLength": 80,
          "description": "Short name shown in the comparison (default: domain)."
        },
        "url": {
          "type": "string",
          "minLength": 3,
          "maxLength": 2048,
          "description": "Domain or page URL (fetched, robots.txt respected)."
        },
        "html": {
          "type": "string",
          "minLength": 20,
          "maxLength": 1900000,
          "description": "Already loaded HTML (nothing is fetched). The whole request is limited to 2 MB."
        },
        "base_url": {
          "type": "string",
          "format": "uri",
          "maxLength": 2048,
          "description": "URL of the supplied HTML (required with html)."
        },
        "extra_pages": {
          "type": "array",
          "maxItems": 4,
          "description": "Offline mode only: further pages of the same site (payment, shipping) as { url, html }.",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "url",
              "html"
            ],
            "properties": {
              "url": {
                "type": "string",
                "format": "uri",
                "maxLength": 2048
              },
              "html": {
                "type": "string",
                "minLength": 20,
                "maxLength": 1900000
              }
            }
          }
        }
      }
    },
    "competitors": {
      "type": "array",
      "minItems": 1,
      "maxItems": 6,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "label": {
            "type": "string",
            "maxLength": 80,
            "description": "Short name shown in the comparison (default: domain)."
          },
          "url": {
            "type": "string",
            "minLength": 3,
            "maxLength": 2048,
            "description": "Domain or page URL (fetched, robots.txt respected)."
          },
          "html": {
            "type": "string",
            "minLength": 20,
            "maxLength": 1900000,
            "description": "Already loaded HTML (nothing is fetched). The whole request is limited to 2 MB."
          },
          "base_url": {
            "type": "string",
            "format": "uri",
            "maxLength": 2048,
            "description": "URL of the supplied HTML (required with html)."
          },
          "extra_pages": {
            "type": "array",
            "maxItems": 4,
            "description": "Offline mode only: further pages of the same site (payment, shipping) as { url, html }.",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "url",
                "html"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "format": "uri",
                  "maxLength": 2048
                },
                "html": {
                  "type": "string",
                  "minLength": 20,
                  "maxLength": 1900000
                }
              }
            }
          }
        }
      }
    },
    "dimensions": {
      "type": "array",
      "minItems": 1,
      "maxItems": 3,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "languages",
          "payment_methods",
          "shipping_countries"
        ]
      },
      "default": [
        "languages",
        "payment_methods",
        "shipping_countries"
      ]
    }
  }
}

Open original schema

Published input example

{
  "subject": {
    "url": "https://halowerk.com/"
  },
  "competitors": [
    {
      "url": "https://netzhandwerker.de/"
    }
  ],
  "dimensions": [
    "languages",
    "payment_methods"
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’