# USPTO Trademark Portfolio Report (`nexgenwatch/trademark-portfolio-report`) Actor

- **URL**: https://apify.com/nexgenwatch/trademark-portfolio-report.md
- **Developed by:** [NexGen Watch](https://apify.com/nexgenwatch) (community)
- **Categories:** Business, News
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $10,050.00 / 1,000 portfolio risk digests

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## USPTO Trademark Portfolio Report

**One priced report that watches your whole trademark family for the two deadlines that cost clients marks: the 30-day opposition window and the §8/§9 maintenance-and-renewal clock.** Feed in your portfolio's serial and/or registration numbers (up to 50) and get back a per-mark status plus a single rendered **portfolio risk digest** — built entirely from the public, logged-out **USPTO Trademark Official Gazette**.

For an IP-counsel or docketing team, one run is a per-portfolio risk sweep: a fraction of a single docketing-software seat, with no seat minimums, no annual contract, and no login to a paid database. Run it weekly against your family and you have a standing opposition/renewal early-warning line for the price of a report, not a platform.

### What you get

- **`portfolio_report`** — one rendered Markdown risk digest (also stored in the key-value store under `PORTFOLIO_REPORT`), leading with open **opposition windows**, then **maintenance & renewal deadlines**, a ranked **deadline-risk** table, and the quiet marks. This is the single charged deliverable.
- **`mark_status`** — one structured record per portfolio mark: observed Gazette events, computed opposition/maintenance deadlines with risk bands, risk flags, and the source issue/page each fact was read from. Never separately billed.
- **`source_receipt`** — always emitted, never billed: index/issue terminal state, canary result, pages parsed, byte/request counters.

### How deadlines are derived

- **Opposition window** — from a `PUBLICATION_FOR_OPPOSITION` event: deadline = publication + 30 days (15 U.S.C. §1063), flagged `OPPOSITION_WINDOW_OPEN` while open.
- **Maintenance / renewal** — from a printed registration date: §8 Declaration at year 6, combined §8&9 renewal at year 10 and every 10 years thereafter, each with a 6-month grace period. Risk bands: `OVERDUE` / `IN_GRACE` / `DUE_SOON` / `UPCOMING` / `OK`.

### Honest limits

Public / logged-out **Official Gazette only** — not TSDR live status, not legal docketing, not comprehensive clearance, not legal advice. The Gazette is **weekly and event-oriented — absence proves nothing**: a mark not seen in the scanned issues is reported as `no_recent_gazette_activity`, and maintenance deadlines are computed only for marks whose registration or renewal was printed in a scanned issue. Deadline math is arithmetic on printed dates; confirm against the official record. TSDR/ODP APIs are excluded because they now require an account/API key. Deterministic, no LLM. Blocks and malformed issues fail loud (`Actor.fail`) — never a clean empty, and never a charge.

### Compliance

Logged-out official USPTO PDFs only. No login, API key, CAPTCHA or paywall defeating; no licensed source or third-party mirror; robots honored. Identity is office + serial/registration number; official Gazette event codes only — legal outcomes are never inferred.

### Pricing

`apify-actor-start` $0.05 (one-time, platform-charged). `portfolio_report` is charged **exactly once per run and only on successful delivery** — a valid mark list that produces a report charges once; a source failure charges nothing.

# Actor input Schema

## `serialNumbers` (type: `array`):

Portfolio trademark serial numbers, each exactly 8 digits after punctuation removal. Combined with registrationNumbers, up to 50 marks per run.
## `registrationNumbers` (type: `array`):

Portfolio registration numbers, each 1-8 digits after punctuation removal. Combined with serialNumbers, up to 50 marks per run.
## `issuesToScan` (type: `integer`):

How many of the latest weekly USPTO Official Gazette issues to scan for portfolio activity (1-4). Each issue is a large public PDF; more issues widen the opposition/registration lookback.
## `maxPagesScanned` (type: `integer`):

Optional hard cap on Gazette PDF pages scanned per issue. Bounds runtime on the very large official PDFs; a capped scan is reported PARTIAL but still delivers the report.
## `includeGoodsServices` (type: `boolean`):

Extract printed identification-of-goods text where present (capped 20,000 chars/record).
## `asOfDate` (type: `string`):

YYYY-MM-DD reference date for opposition/renewal deadline math. Null means the run date. Deterministic when supplied.
## `useApifyProxy` (type: `boolean`):

Route requests through Apify Proxy. Off by default: the official PDFs are public and download faster directly. A proxy never turns a block into success.

## Actor input object example

```json
{
  "registrationNumbers": [
    "1078312",
    "1323343"
  ],
  "issuesToScan": 2,
  "maxPagesScanned": 50,
  "includeGoodsServices": true,
  "useApifyProxy": false
}
````

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "registrationNumbers": [
        "1078312",
        "1323343"
    ],
    "maxPagesScanned": 50
};

// Run the Actor and wait for it to finish
const run = await client.actor("nexgenwatch/trademark-portfolio-report").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "registrationNumbers": [
        "1078312",
        "1323343",
    ],
    "maxPagesScanned": 50,
}

# Run the Actor and wait for it to finish
run = client.actor("nexgenwatch/trademark-portfolio-report").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "registrationNumbers": [
    "1078312",
    "1323343"
  ],
  "maxPagesScanned": 50
}' |
apify call nexgenwatch/trademark-portfolio-report --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=nexgenwatch/trademark-portfolio-report",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "USPTO Trademark Portfolio Report",
        "version": "0.1",
        "x-build-id": "uXiaGlaO2QM0ZTRVn"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/nexgenwatch~trademark-portfolio-report/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-nexgenwatch-trademark-portfolio-report",
                "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/nexgenwatch~trademark-portfolio-report/runs": {
            "post": {
                "operationId": "runs-sync-nexgenwatch-trademark-portfolio-report",
                "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/nexgenwatch~trademark-portfolio-report/run-sync": {
            "post": {
                "operationId": "run-sync-nexgenwatch-trademark-portfolio-report",
                "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": {
                    "serialNumbers": {
                        "title": "Serial numbers",
                        "type": "array",
                        "description": "Portfolio trademark serial numbers, each exactly 8 digits after punctuation removal. Combined with registrationNumbers, up to 50 marks per run.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "registrationNumbers": {
                        "title": "Registration numbers",
                        "type": "array",
                        "description": "Portfolio registration numbers, each 1-8 digits after punctuation removal. Combined with serialNumbers, up to 50 marks per run.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "issuesToScan": {
                        "title": "Gazette issues to scan",
                        "minimum": 1,
                        "maximum": 4,
                        "type": "integer",
                        "description": "How many of the latest weekly USPTO Official Gazette issues to scan for portfolio activity (1-4). Each issue is a large public PDF; more issues widen the opposition/registration lookback.",
                        "default": 2
                    },
                    "maxPagesScanned": {
                        "title": "Max pages scanned per issue (advanced)",
                        "minimum": 1,
                        "maximum": 40000,
                        "type": "integer",
                        "description": "Optional hard cap on Gazette PDF pages scanned per issue. Bounds runtime on the very large official PDFs; a capped scan is reported PARTIAL but still delivers the report."
                    },
                    "includeGoodsServices": {
                        "title": "Include goods and services",
                        "type": "boolean",
                        "description": "Extract printed identification-of-goods text where present (capped 20,000 chars/record).",
                        "default": true
                    },
                    "asOfDate": {
                        "title": "As-of date",
                        "type": "string",
                        "description": "YYYY-MM-DD reference date for opposition/renewal deadline math. Null means the run date. Deterministic when supplied."
                    },
                    "useApifyProxy": {
                        "title": "Use Apify Proxy",
                        "type": "boolean",
                        "description": "Route requests through Apify Proxy. Off by default: the official PDFs are public and download faster directly. A proxy never turns a block into success.",
                        "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
                                    }
                                }
                            },
                            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
