{
  "openapi": "3.0.1",
  "info": {
    "title": "USPTO Trademark Search & Monitor: Names & Slogans",
    "description": "USPTO trademark search, checker, scraper and API: is a brand name or t-shirt slogan already taken? Sound-alikes included. Search marks by owner or by product, look up serial numbers with renewal dates, and monitor new filings and opposition deadlines.",
    "version": "0.2",
    "x-build-id": "xrfUWa0n9vMpZ6V4u"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/quillstone-labs~uspto-trademark-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-quillstone-labs-uspto-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/quillstone-labs~uspto-trademark-search/runs": {
      "post": {
        "operationId": "runs-sync-quillstone-labs-uspto-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/quillstone-labs~uspto-trademark-search/run-sync": {
      "post": {
        "operationId": "run-sync-quillstone-labs-uspto-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": {
          "mode": {
            "title": "What do you want to do?",
            "enum": [
              "check",
              "slogan",
              "owner",
              "goods",
              "watch",
              "lookup"
            ],
            "type": "string",
            "description": "<strong>Check names:</strong> is a brand name already taken? Catches sound-alikes too.<br><strong>Check slogans:</strong> does a phrase contain someone's trademark? Best for t-shirt and merch designs.<br><strong>Search by owner:</strong> every mark a company or person holds, with renewal dates.<br><strong>Search by products or services:</strong> live marks whose goods and services mention every word you give, like <code>dog shampoo</code>: who already has trademarks for that kind of product.<br><strong>Watch new filings:</strong> new applications that mention your keywords, and marks newly published for opposition. Put it on a schedule.<br><strong>Look up:</strong> full records by serial or registration number.",
            "default": "check"
          },
          "terms": {
            "title": "Your list",
            "type": "array",
            "description": "One per line. Brand names, slogans, owner names, product descriptions or watch keywords, depending on what you picked above. For look-ups, use the Serial or registration numbers field further down instead. Calls written for other trademark Actors also work: <code>names</code>, <code>keywords</code> and <code>queries</code> are read too.",
            "items": {
              "type": "string"
            }
          },
          "products": {
            "title": "What are you selling?",
            "type": "array",
            "description": "Pick your products and the matching trademark classes are filled in for you. This keeps results to marks that could actually affect you. Leave empty to search every class.",
            "items": {
              "type": "string",
              "enum": [
                "apparel",
                "mugs",
                "stickers",
                "posters-prints",
                "phone-cases",
                "bags-totes",
                "jewelry",
                "pillows-cushions",
                "blankets-towels",
                "toys-games",
                "candles"
              ],
              "enumTitles": [
                "T-shirts, hoodies & hats (class 25)",
                "Mugs & drinkware (21)",
                "Stickers (16)",
                "Posters & prints (16)",
                "Phone cases (9)",
                "Bags & totes (18)",
                "Jewelry (14)",
                "Pillows & cushions (20)",
                "Blankets & towels (24)",
                "Toys & games (28)",
                "Candles (4)"
              ]
            }
          },
          "classes": {
            "title": "Extra class numbers",
            "type": "array",
            "description": "Nice class numbers to search on top of the products above, e.g. 9 for software or 41 for entertainment. Leave empty if the product list covers you.",
            "items": {
              "type": "string"
            }
          },
          "liveOnly": {
            "title": "Live marks only",
            "type": "boolean",
            "description": "Skip dead marks (abandoned, cancelled or expired). Turn off to see a name's full history.",
            "default": true
          },
          "soundAlike": {
            "title": "Catch sound-alikes and misspellings",
            "type": "boolean",
            "description": "For name checks: also find marks that sound the same or are spelled a little differently, like NYKE for NIKE. Each gets a similarity score from 0 to 100.",
            "default": true
          },
          "shortAnswers": {
            "title": "Short answers only",
            "type": "boolean",
            "description": "Return just the verdict and the top 3 marks behind it (name, status, classes, owner, link) for each line, without full records and goods-and-services text. Quicker to read for dashboards and automated tools. The Excel report still has everything.",
            "default": false
          },
          "maxMatchesPerTerm": {
            "title": "Marks to list per line",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "How many marks to show under each name or slogan. The verdict always looks further than this, so a low number won't hide an exact match. In products or services searches, it is how many marks to return per description.",
            "default": 20
          },
          "numbers": {
            "title": "Serial or registration numbers",
            "type": "array",
            "description": "For Look up. One per line. Serial numbers have 8 digits; registration numbers have 7 or fewer.",
            "items": {
              "type": "string"
            }
          },
          "maxMarksPerOwner": {
            "title": "Marks per owner",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "For Search by owner. How many marks to return for each owner, newest first.",
            "default": 100
          },
          "watchName": {
            "title": "Watch name",
            "type": "string",
            "description": "Give each brand you watch its own name, like my-brand. Runs with the same watch name remember what they've already shown you and only return new alerts.",
            "default": "default"
          },
          "lookbackDays": {
            "title": "First run looks back (days)",
            "minimum": 1,
            "maximum": 90,
            "type": "integer",
            "description": "How far back the very first run of a watch looks. Later runs only show what's new.",
            "default": 7
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "USPTO limits how many searches one IP address can make. With Apify Proxy the Actor switches IP when it reaches that limit; without it, large runs pause for five minutes each time.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}