USPTO PTAB Trial proceedings CLI — search IPR/PGR/CBM decisions from the terminal
Project description
ptab-cli
USPTO PTAB(Patent Trial and Appeal Board) API를 터미널에서 직접 조회하는 CLI 도구. IPR/PGR/CBM Trial 절차·결정·문서, 항소 결정, 저촉심사 결정을 검색·조회합니다.
설치
pip install ptab-cli
# 또는
uv tool install ptab-cli
# 또는
pipx install ptab-cli
빠른 시작
# 1. API 키 저장
ptab configure
# 2. IPR 절차 검색
ptab proc search --q "petitionerPartyName:Apple" --type IPR
# 3. Trial 번호로 단건 조회
ptab proc get IPR2023-00001
# 4. Trial의 결정 목록
ptab decision list IPR2023-00001
API 키 설정
우선순위 (높은 순):
| 방식 | 예시 |
|---|---|
| 명령어 옵션 | ptab proc get IPR2023-00001 --api-key KEY |
| 환경변수 | export USPTO_API_KEY=KEY |
| 설정 파일 | ptab configure → ~/.ptab-cli.toml |
ptab configure # 대화형 설정
ptab configure --show # 현재 설정 확인
명령어
proc — Trial 절차 (IPR/PGR/CBM)
ptab proc search [--q Q] [--type IPR|PGR|CBM] [--from DATE] [--to DATE] [--limit N] [--sort FIELD]
ptab proc get TRIAL_NUMBER
ptab proc download [--q Q] --out FILE.zip
decision — Trial 결정
ptab decision search [--q Q] [--type TYPE] [--petitioner NAME] [--patent NUMBER] [--from DATE] [--to DATE]
ptab decision get DOC_ID
ptab decision list TRIAL_NUMBER
ptab decision download [--q Q] --out FILE.zip
doc — Trial 문서
ptab doc search [--q Q] [--type TYPE] [--from DATE] [--to DATE]
ptab doc get DOC_ID
ptab doc list TRIAL_NUMBER
ptab doc download [--q Q] --out FILE.zip
appeal — 항소 결정
ptab appeal search [--q Q] [--from DATE] [--to DATE]
ptab appeal get DOC_ID
ptab appeal list APPEAL_NUMBER
ptab appeal download [--q Q] --out FILE.zip
interference — 저촉심사 결정
ptab interference search [--q Q] [--from DATE] [--to DATE]
ptab interference get DOC_ID
ptab interference list INTERFERENCE_NUMBER
ptab interference download [--q Q] --out FILE.zip
공통 옵션
모든 search 명령에 적용:
--q TEXT Lucene 쿼리 문자열
--from DATE 시작일 (YYYY-MM-DD)
--to DATE 종료일 (YYYY-MM-DD)
--limit N 최대 결과 수 (기본: 25)
--offset N 페이지 오프셋 (기본: 0)
--sort FIELD 정렬 필드 (예: "filingDate desc")
--format/-f 출력 포맷: table | json | csv (기본: table)
--out FILE 결과 저장 경로 (csv/json)
--api-key KEY API 키 (일회성 override)
글로벌 옵션:
--verbose/-v HTTP 요청/응답 디버그 로그 (stderr)
--timeout N 요청 타임아웃 초
--version 버전 출력
출력 포맷
table (기본) — 터미널 가독성 우선, 핵심 필드만 표시:
┌──────────────────┬──────┬──────────────┬────────────────┬──────────────┐
│ Trial Number │ Type │ Filing Date │ Patent Owner │ Status │
├──────────────────┼──────┼──────────────┼────────────────┼──────────────┤
│ IPR2023-00001 │ IPR │ 2023-01-05 │ Acme Corp │ Terminated │
└──────────────────┴──────┴──────────────┴────────────────┴──────────────┘
총 1건
json — API 응답 원문 pretty-print (파이프라인 연계용)
csv — 헤더 포함 CSV (스프레드시트·데이터 분석용)
사용 예시
# 2023년 Apple IPR 청구 검색
ptab proc search --q "petitionerPartyName:Apple" --type IPR --from 2023-01-01 --to 2023-12-31
# Trial 단건 조회 (JSON 출력)
ptab proc get IPR2023-00001 --format json
# 최종 서면 결정 CSV 저장
ptab decision search --type "Final Written Decision" --from 2024-01-01 --format csv --out decisions.csv
# Samsung IPR 절차 ZIP 다운로드
ptab proc download --q "petitionerPartyName:Samsung" --type IPR --out samsung_ipr.zip
# Trial 문서 목록
ptab doc list IPR2023-00001
# Lucene 쿼리 조합
ptab proc search --q "statusCategory:Terminated AND trialMetaData.trialTypeCode:IPR"
요구사항
- Python 3.11 이상
- USPTO PTAB API 키 (developer.uspto.gov 에서 발급)
라이선스
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ptab_cli-0.1.0.tar.gz.
File metadata
- Download URL: ptab_cli-0.1.0.tar.gz
- Upload date:
- Size: 54.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7dfa57d19a189ee557c28e0793d9198ce9e35e3a0d9f4cc3d3b0cc7206616ef5
|
|
| MD5 |
5fdeac0ad89a42ee4a2caef92ab49612
|
|
| BLAKE2b-256 |
7ba5f5046257018335965c3c758051176058e3b10ca37ccec783781df3c38746
|
File details
Details for the file ptab_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: ptab_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 24.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
052a7256c9702318535252c8a4288174c775b38b5fcb62115d0f49ed5eec9e6a
|
|
| MD5 |
227d016c534bdf77b7908874df7bc5af
|
|
| BLAKE2b-256 |
c12a34a13e9139e8c3fe59e731fe61e1e34a70bec129a10664fc4b73e4d13ac3
|