{
  "openapi": "3.0.1",
  "info": {
    "title": "USPTO Scraper | Trademark Search and Status",
    "description": "USPTO trademark scraper: search the US trademark register by brand name, owner or goods and services, or pull marks by serial number or TSDR link. Get status, owner and address, Nice classes, filing dates, drawing type, filing basis and documents. 50 trademarks in 1 second, 37 fields each. No login.",
    "version": "1.0",
    "x-build-id": "tSpdywTqiTT1UEOr3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~uspto-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-uspto-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/silentflow~uspto-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-uspto-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/silentflow~uspto-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-uspto-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": {
          "keywords": {
            "title": "🔎 Keywords",
            "type": "array",
            "description": "Brand names, slogans or words to search in the US trademark register, one per line (<code>nike</code>, <code>just do it</code>). Exact matches come first, then marks that contain every word. A common word returns a few hundred marks, live and dead.<br><br>Power users can type the register's own syntax, for example <code>WM:coffee AND IC:030</code>.",
            "items": {
              "type": "string"
            }
          },
          "trademarkIds": {
            "title": "🔢 Serial or registration numbers",
            "type": "array",
            "description": "Pull specific marks by number, one per line: an 8-digit serial number (<code>97123456</code>) or a registration number (<code>1237469</code>, <code>Reg. No. 978,952</code>). Every number comes back whatever the filters below say. Hundreds of numbers are read in one request.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 USPTO links",
            "type": "array",
            "description": "Paste links to trademark records as you find them in emails and spreadsheets: TSDR status pages (<code>https://tsdr.uspto.gov/#caseNumber=97123456...</code>, <code>tsdr.uspto.gov/statusview/sn97123456</code>) and Trademark Search result links (<code>tmsearch.uspto.gov/search/search-results/97123456</code>).",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "searchIn": {
            "title": "🎯 Search keywords in",
            "enum": [
              "mark",
              "owner",
              "goods",
              "all"
            ],
            "type": "string",
            "description": "Where the keywords are looked for. <b>Mark name</b> is the clearance search. <b>Owner name</b> maps a company's whole portfolio (<code>Lucasfilm</code> returns more than 1,400 marks). <b>Goods and services</b> finds every mark filed for a product (<code>electric bicycles</code>). <b>Everywhere</b> combines the three.",
            "default": "mark"
          },
          "maxItems": {
            "title": "🔢 Max trademarks",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many trademarks in total, across every keyword and number. Each trademark is one row.",
            "default": 100
          },
          "status": {
            "title": "🚦 Status",
            "enum": [
              "all",
              "live",
              "registered",
              "pending",
              "dead"
            ],
            "type": "string",
            "description": "<b>Live</b> keeps registered marks and pending applications, the ones that still block a new filing. <b>Dead</b> keeps abandoned, cancelled and expired marks.",
            "default": "all"
          },
          "classes": {
            "title": "🏷️ Nice classes",
            "type": "array",
            "description": "Keep marks filed in at least one of these classes. Leave empty for every class. Class 25 is clothing, 9 software and electronics, 35 business services, 42 software as a service.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20",
                "21",
                "22",
                "23",
                "24",
                "25",
                "26",
                "27",
                "28",
                "29",
                "30",
                "31",
                "32",
                "33",
                "34",
                "35",
                "36",
                "37",
                "38",
                "39",
                "40",
                "41",
                "42",
                "43",
                "44",
                "45"
              ],
              "enumTitles": [
                "1: Chemicals",
                "2: Paints and coatings",
                "3: Cosmetics and cleaning products",
                "4: Lubricants, fuels and candles",
                "5: Pharmaceuticals and supplements",
                "6: Metal goods",
                "7: Machinery",
                "8: Hand tools and cutlery",
                "9: Software, electronics and scientific devices",
                "10: Medical devices",
                "11: Lighting, heating and appliances",
                "12: Vehicles",
                "13: Firearms and fireworks",
                "14: Jewelry and watches",
                "15: Musical instruments",
                "16: Paper goods and printed matter",
                "17: Rubber and plastics",
                "18: Leather goods and bags",
                "19: Building materials (non-metal)",
                "20: Furniture",
                "21: Housewares and glassware",
                "22: Ropes, tents and fibers",
                "23: Yarns and threads",
                "24: Textiles and bedding",
                "25: Clothing, footwear and headwear",
                "26: Lace, buttons and hair accessories",
                "27: Carpets and floor coverings",
                "28: Toys, games and sporting goods",
                "29: Meat, dairy and processed foods",
                "30: Coffee, bakery and staple foods",
                "31: Fresh produce and animal food",
                "32: Beer and soft drinks",
                "33: Wines and spirits",
                "34: Tobacco and vaping",
                "35: Advertising and business services",
                "36: Financial and real estate services",
                "37: Construction and repair",
                "38: Telecommunications",
                "39: Transport and travel",
                "40: Treatment of materials",
                "41: Education and entertainment",
                "42: Software as a service and technology",
                "43: Restaurants and hotels",
                "44: Medical and beauty services",
                "45: Legal and personal services"
              ]
            }
          },
          "filedAfter": {
            "title": "📅 Filed after",
            "type": "string",
            "description": "Only keep marks filed on or after this date. Pick a date (<code>2026-01-01</code>) or an age (<code>7 days</code>, <code>3 months</code>): on a weekly schedule, <code>7 days</code> with <b>Newest first</b> returns this week's new applications."
          },
          "sortBy": {
            "title": "↕️ Sort by",
            "enum": [
              "relevance",
              "newest",
              "oldest"
            ],
            "type": "string",
            "description": "<b>Relevance</b> puts exact matches first and reads up to 10,000 marks per keyword. <b>Newest first</b> and <b>Oldest first</b> order by filing date with no such limit. Without keywords the newest filings always come first.",
            "default": "relevance"
          },
          "includeDetails": {
            "title": "📜 Add status history, deadlines and contacts",
            "type": "boolean",
            "description": "Adds the case file to every mark: the status in plain English and its date, the next maintenance deadlines (Sections 8 and 9), the attorney's email, the correspondent's name, email and address, the 20 latest prosecution events and the opposition and cancellation proceedings. One extra lookup per mark, so about 40 marks per minute instead of hundreds per second. A mark whose case file cannot be read still ships without it.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}