Extract verified company data from website Impressum pages API

Takes a website URL, finds and fetches the site's Impressum or imprint page, extracts structured company details with an AI model, verifies each value against

Input

Send these Fields as input. A Field not listed here is refused.

website

Website

  • Type: string
  • Required: yes
  • Length in characters: 1 to 2048

organization

Organization (optional hint for the model)

  • Type: string
  • Required: no
  • Length in characters: at most 300

reference_id

Reference ID (optional, returned as is)

  • Type: string
  • Required: no
  • Length in characters: at most 200

Run it

One call presses the Widget and answers the run once its status is succeeded or failed, however long it takes. The key is read from ABYSS_API_KEY. Install the library with npm install abysshub or pip install abysshub; cURL sends the Fields as a form.

JavaScript

// index.mjs
import Abyss from "abysshub";

const abyss = new Abyss();

const run = await abyss.run("widget_378", {
  website: "https://www.ravensburger.de",
  organization: "Ravensburger",
});

console.log(run.result);

Python

from abysshub import Abyss

abyss = Abyss()

run = abyss.run("widget_378", {
    "website": "https://www.ravensburger.de",
    "organization": "Ravensburger",
})

print(run.result)

cURL

curl https://api.abysshub.com/v1/widgets/widget_378/runs \
  -H "Authorization: Bearer $ABYSS_API_KEY" \
  -F website=https://www.ravensburger.de \
  -F organization=Ravensburger

A succeeded run carries its result and its output_files. Their URLs are signed for each read: re-read the run, never store a URL. A run still queued or running in the answer (after an hour, or when the API is busy) is read again at its Location with ?wait=true.

What it answers

The Example Run's result, the JSON the Widget wrote to output/output.json:

{
  "status": "ok",
  "reference_id": null,
  "website": "https://www.ravensburger.de",
  "impressum_url": "https://www.ravensburger.de/de-DE/start/impressum",
  "data": {
    "company_name": "Ravensburger Verlag GmbH",
    "legal_form": "GmbH",
    "street": "Otto-Maier-Straße 1",
    "postal_code": "88214",
    "city": "Ravensburg",
    "country": "Germany",
    "vat_id": "DE811514466",
    "register_court": "Amtsgericht Ulm",
    "register_number": "HRB 551355",
    "representatives": [
      {
        "name": "Dr. Anuschka Albertz",
        "role": "Geschäftsführung"
      },
      {
        "name": "Thomas Bleyer",
        "role": "Geschäftsführung"
      },
      {
        "name": "Susanne Knoche",
        "role": "Geschäftsführung"
      }
    ]
  },
  "dropped_fields": [],
  "reason": null
}

More

Keys, files, errors and limits: API access.