{ "openapi": "3.0.1", "info": { "title": "German Trademark Register Scraper", "description": "Search the German trademark register (DPMA). Export names, filing & registration dates, applicants, Nice classes (Nizza Klassen), goods & services, legal status and the real figurative mark images.", "version": "0.1", "x-build-id": "7AYIBfaRJodzAH4Vm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nowologix~german-trademark-register-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nowologix-german-trademark-register-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nowologix~german-trademark-register-scraper/runs": { "post": { "operationId": "runs-sync-nowologix-german-trademark-register-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nowologix~german-trademark-register-scraper/run-sync": { "post": { "operationId": "run-sync-nowologix-german-trademark-register-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mockMode": { "title": "Demo mode (bundled sample data)", "type": "boolean", "description": "When ON, the actor returns a small bundled sample of records (incl. a figurative mark image) so you can see the output shape. This is not live register data. Turn OFF to scrape live from DPMAregister.", "default": false }, "markText": { "title": "Trademark text (MARKE)", "type": "string", "description": "The word / verbal element of the mark. Wildcards: ? (any chars), ! (one char), # (one or no char). Example: Apple or App?e" }, "applicant": { "title": "Applicant / proprietor (INH)", "type": "string", "description": "Name of the applicant or proprietor. Example: Apple Inc." }, "niceClasses": { "title": "Nice class(es) (KL)", "type": "string", "description": "One or more Nice classes (1 to 45), comma or space separated. Example: 9, 35, 42" }, "registrationNumber": { "title": "Registration / file number (RN)", "type": "string", "description": "Exact registration number or file number (Aktenzeichen). Example: 30512345" }, "markForm": { "title": "Trademark form (MF)", "type": "string", "description": "DPMA Markenform, for example Wortmarke, Bildmarke, Wort-Bildmarke. Leave empty for all forms." }, "database": { "title": "Data stock (DB)", "enum": [ "DE", "EM", "IR", "" ], "type": "string", "description": "Which register to search: German national marks (DE), EU marks (EM) or international registrations (IR).", "default": "DE" }, "applicationDateFrom": { "title": "Filed from (AT >=)", "type": "string", "description": "Only marks with an application date (Anmeldetag) on or after this date." }, "applicationDateTo": { "title": "Filed until (AT <=)", "type": "string", "description": "Only marks with an application date (Anmeldetag) on or before this date." }, "status": { "title": "Status (ST)", "type": "string", "description": "Filter by current status, for example Marke eingetragen. Leave empty for any status." }, "rawQuery": { "title": "Raw expert query", "type": "string", "description": "DPMAregister expert syntax. Operators UND / ODER / NICHT, comparisons = >= <= > <, wildcards ? ! #, quotes for phrases, ( ) grouping. Example: MARKE=Apple UND (KL=09 ODER KL=42) UND AT>=01.01.2015" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 250, "type": "integer", "description": "Maximum number of records to export. The scraper pages through the hit list (25 per page) until this many are collected.", "default": 50 }, "fetchDetails": { "title": "Fetch full detail per mark", "type": "boolean", "description": "Fetch the detail page for every hit to get goods and services, applicant, dates, opposition period, and the full status history. Turn OFF for a faster list-only run.", "default": true }, "downloadImages": { "title": "Download figurative mark images (Bildmarken)", "type": "boolean", "description": "Download the full-resolution mark image for figurative marks and store it in the key-value store. Word-only marks have no image.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many detail/image requests to run in parallel. Keep it modest to stay polite to the server.", "default": 4 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Small pause between detail requests.", "default": 150 }, "useProxy": { "title": "Use Apify proxy", "type": "boolean", "description": "Route the browser through Apify Proxy. Recommended to reduce the chance of rate limiting or blocks.", "default": true }, "watchMode": { "title": "Enable monitoring mode", "type": "boolean", "description": "Only export marks not seen in earlier runs. Seen marks are remembered across runs in a named key-value store.", "default": false }, "watchId": { "title": "Monitor label", "type": "string", "description": "Optional label to keep multiple monitors apart, for example my-brand. Defaults to a hash of your query." }, "alertOnFirstRun": { "title": "Report matches on the first run", "type": "boolean", "description": "By default the first run only establishes a baseline. Enable this to also export and alert on all current matches the first time.", "default": false }, "notifyWebhookUrl": { "title": "Notify webhook URL", "type": "string", "description": "If set, new marks are POSTed as JSON to this URL (Slack, Make, Zapier, n8n, etc.)." }, "notifyEmail": { "title": "Notify e-mail", "type": "string", "description": "If set, a summary of new marks is e-mailed here (uses the apify/send-mail integration)." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }