{ "openapi": "3.0.1", "info": { "title": "Trademark Search: USPTO, TMview, Madrid, IP Australia", "description": "One row per trademark mark from USPTO, TMview, Madrid and IP Australia: mark text, owner, live/dead/pending status with the office's own wording kept, serial and registration numbers, Nice classes, goods and services text, dates, and per-source status flags.", "version": "0.1", "x-build-id": "CZFUeFtdTsLW8P8iZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~trademark-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-trademark-search", "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/s-r~trademark-search/runs": { "post": { "operationId": "runs-sync-s-r-trademark-search", "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/s-r~trademark-search/run-sync": { "post": { "operationId": "run-sync-s-r-trademark-search", "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": { "mark": { "title": "Mark text", "type": "string", "description": "Word mark to search for across the registers, e.g. NIKE or CREATE-A-CUP. Leave empty to look up a number instead." }, "number": { "title": "Serial, registration number or IRN", "type": "string", "description": "Exact identifier. A US application serial (78888801), a US registration number (3000000), or a Madrid international registration number (1000000). Optional when mark text is given." }, "number_kind": { "title": "Number type", "enum": [ "auto", "application_number", "registration_number", "irn" ], "type": "string", "description": "What the number field holds. Auto works it out from the shape; the explicit options force it.", "default": "auto" }, "mode": { "title": "Mode", "enum": [ "lookup", "search", "classes" ], "type": "string", "description": "Lookup resolves one mark by identifier. Search runs a word-mark query and returns up to max_rows rows. Classes returns the Nice classification headings instead of marks.", "default": "lookup" }, "offices": { "title": "Offices", "type": "string", "description": "Comma separated office codes to consult. US (USPTO), EM (EU), WO (Madrid), AU (IP Australia), GB, FR, DE, JP, CA, IN, BX, or any two-letter office code the shared indexes carry. Empty means every office." }, "nice_classes": { "title": "Nice classes", "type": "string", "description": "Comma separated Nice classification numbers, 1 to 45, to filter on. Empty means all classes." }, "max_rows": { "title": "Maximum rows", "minimum": 1, "maximum": 500, "type": "number", "description": "Upper bound on rows returned per source, 1 to 500. Broad mark searches are partitioned by filing-date window rather than cut off at the index ceiling.", "default": 50 }, "include_goods_services": { "title": "Include goods and services", "type": "boolean", "description": "Fetch the goods and services wording from the full record where it is reachable. Adds one request per row, capped at 40 per run.", "default": true } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }