{
  "openapi": "3.0.1",
  "info": {
    "title": "Trademark Search API & Watch: USPTO + Australia",
    "description": "Trademark search: check whether a brand name is already registered. Search by word mark, owner or Nice class in the US (USPTO) and Australia, with exact, fuzzy and sound-alike flags, plus trademark watch for new filings. Pay per row; no API key for Australia.",
    "version": "0.1",
    "x-build-id": "dWEMLpfSLq1rfO5xJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/data-done-right~trademark-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-data-done-right-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/data-done-right~trademark-search/runs": {
      "post": {
        "operationId": "runs-sync-data-done-right-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/data-done-right~trademark-search/run-sync": {
      "post": {
        "operationId": "run-sync-data-done-right-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": {
          "office": {
            "title": "Trademark office",
            "enum": [
              "AU",
              "US"
            ],
            "type": "string",
            "description": "AU = Australian register from IP Australia open data (no key needed, refreshed weekly). US = USPTO through its official APIs (needs a free USPTO key, see below).",
            "default": "AU"
          },
          "mode": {
            "title": "What do you want?",
            "enum": [
              "search",
              "lookup",
              "watch"
            ],
            "type": "string",
            "description": "Search marks by word mark, owner and Nice class; look up marks by number; or watch: report only NEW filings that match your brand terms since the last run (schedule it daily or weekly).",
            "default": "search"
          },
          "searchTerms": {
            "title": "Word marks (search or watch terms)",
            "type": "array",
            "description": "Brand names or words to search for, one per line. Matching ignores case, accents, punctuation and spacing.",
            "items": {
              "type": "string"
            }
          },
          "matchType": {
            "title": "Match type",
            "enum": [
              "exact",
              "contains",
              "fuzzy"
            ],
            "type": "string",
            "description": "exact = same text; contains = the term appears inside the mark; fuzzy = also close spellings (small edit distance) and sound-alikes (Soundex). Every row says which kind of match it is.",
            "default": "contains"
          },
          "fuzzySimilarity": {
            "title": "Fuzzy similarity (%)",
            "minimum": 50,
            "maximum": 100,
            "type": "integer",
            "description": "For fuzzy: how close a spelling must be. 80 allows about 1 edit per 5 letters. Lower finds more look-alikes and more noise.",
            "default": 80
          },
          "ownerNames": {
            "title": "Owner names",
            "type": "array",
            "description": "Owner (applicant/registrant) name contains this text, e.g. 'qantas airways'. Alone it searches by owner; with word marks it filters the results.",
            "items": {
              "type": "string"
            }
          },
          "niceClasses": {
            "title": "Nice classes",
            "type": "array",
            "description": "Only marks in any of these Nice classes, e.g. 9, 25, 35. Empty means all classes.",
            "items": {
              "type": "string"
            }
          },
          "serialNumbers": {
            "title": "Serial / trade mark numbers",
            "type": "array",
            "description": "Lookup mode. US: 8-digit serial numbers (e.g. 97123456). AU: trade mark numbers (e.g. 1771259).",
            "items": {
              "type": "string"
            }
          },
          "registrationNumbers": {
            "title": "US registration numbers",
            "type": "array",
            "description": "Lookup mode, US only: 7-digit registration numbers (e.g. 4567890).",
            "items": {
              "type": "string"
            }
          },
          "liveOnly": {
            "title": "Live marks only",
            "type": "boolean",
            "description": "Skip dead marks (abandoned, cancelled, expired, lapsed, refused).",
            "default": false
          },
          "filedAfter": {
            "title": "Filed on or after",
            "type": "string",
            "description": "Only marks filed on or after this date (YYYY-MM-DD)."
          },
          "filedBefore": {
            "title": "Filed on or before",
            "type": "string",
            "description": "Only marks filed on or before this date (YYYY-MM-DD)."
          },
          "daysBack": {
            "title": "Days back (US files, first watch run)",
            "minimum": 0,
            "maximum": 90,
            "type": "integer",
            "description": "US search and the first US watch run scan the USPTO daily application files of the last N days (later watch runs continue where the last run stopped, up to 90 days). The first AU watch run reports marks filed in the last N days (at least 7). Max 90.",
            "default": 7
          },
          "newFilingsOnly": {
            "title": "US: new applications only",
            "type": "boolean",
            "description": "On: only cases newly filed in the scanned days. Off: also existing cases that changed (status updates, publication, registration).",
            "default": true
          },
          "includeClasses": {
            "title": "AU: include Nice classes",
            "type": "boolean",
            "description": "Adds the Nice classes of each Australian mark (one more pass over the open data, about 10-30 s).",
            "default": true
          },
          "includeOwners": {
            "title": "AU: include owner and agent",
            "type": "boolean",
            "description": "Adds owner name, state, postcode, country, ABN and agent (one more pass, about 30-60 s). Names of individual owners are withheld in the open data.",
            "default": true
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Caps the rows returned (and so the cost). Best matches first: exact, then contains, then fuzzy; live before dead; newest first.",
            "default": 100
          },
          "watchName": {
            "title": "Watch name",
            "type": "string",
            "description": "Optional label for the watch memory. Runs with the same name share what was already reported. Empty = derived from the office, terms and filters."
          },
          "usptoApiKey": {
            "title": "USPTO TSDR API key",
            "type": "string",
            "description": "US lookup by number. Free: sign in at account.uspto.gov/api-manager and request a TSDR key. Stored as a secret, never logged."
          },
          "odpApiKey": {
            "title": "USPTO Open Data Portal API key",
            "type": "string",
            "description": "US search and watch (daily filing files). Free: USPTO.gov account verified with ID.me, then data.uspto.gov/apikey. Stored as a secret, never logged."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}