Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/max-planck-innovation-competition/go-uspto
Retrieve the latest patents as xml from the USPTO
https://github.com/max-planck-innovation-competition/go-uspto
api-client go golang uspto
Last synced: 17 days ago
JSON representation
Retrieve the latest patents as xml from the USPTO
- Host: GitHub
- URL: https://github.com/max-planck-innovation-competition/go-uspto
- Owner: max-planck-innovation-competition
- License: mit
- Created: 2021-10-20T12:50:11.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T15:49:47.000Z (about 2 months ago)
- Last Synced: 2024-11-29T17:49:43.837Z (about 1 month ago)
- Topics: api-client, go, golang, uspto
- Language: Go
- Homepage:
- Size: 760 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GO USPTO
[](https://goreportcard.com/report/github.com/max-planck-innovation-competition/go-uspto)
[](https://pkg.go.dev/github.com/max-planck-innovation-competition/go-uspto)
Go API client for United States Patent and Trademark Office (USPTO) API
## Status
Alpha Version
**⚠️ Experimental - Not ready for production.**
## Standards
### Grants
At the moment there are parsers that are tested with examples of the following versions of the USPTO XML format:
- [ ] (JAN 1976 – DEC 2001) Patent Grant Full Text Data/APS – Green Book
- [ ] (JAN 2001 – DEC 2001) Patent Grant Full Text Data/SGML Version 2.4
- [x] (JAN 2002 – DEC 2004) Patent Grant Full Text Data/XML Version 2.5
- [ ] (JAN 2005 – DEC 2005) Patent Grant Full Text Data/XML Version 4.0 ICE
- [ ] (JAN 2006 – DEC 2006) Patent Grant Full Text Data/XML Version 4.1 ICE
- [ ] (JAN 2007 – DEC 2012) Patent Grant Full Text Data/XML Version 4.2 ICE
- [ ] (JAN 2013 – DEC 2013) Patent Grant Full Text Data/XML Version 4.3 ICE
- [ ] (JAN 2013 – DEC 2014) Patent Grant Full Text Data/XML Version 4.4 ICE
- [x] (JAN 2015 - Present) Patent Grant Full Text Data/XML Version 4.5 ICE
- [ ] (JAN 2022 - Present) Patent Grant Full Text Data/XML Version 4.6 ICE
[See dtd standards](dtds)
### Applications
- [ ] (JAN 2022 - Present) Patent Application Data/XML Version 4.6 ICE
- [x] (JAN 2015 - DEC 2021) Patent Application Data/XML Version 4.4 ICE
- [ ] (JAN 2013 – DEC 2014) Patent Application Data/XML Version 4.3 ICE
- [ ] (JAN 2007 – DEC 2012) Patent Application Data/XML Version 4.2 ICE
- [ ] (JAN 2006 – DEC 2006) Patent Application Data/XML Version 4.1 ICE
- [x] (JAN 2005 – DEC 2005) Patent Application Data/XML Version 4.0 ICE
- [ ] (JAN 2002 – DEC 2004) Patent Application Data/XML Version 1.6
- [x] (MAR 15, 2001 – DEC 2001) Patent Application Data/XML Version 1.5
[See dtd standards](dtds)
## Installation
Add the package to your project via the following command:
```shell
go get github.com/max-planck-innovation-competition/go-uspto
```
## Usage
Get a list of all the dates where the USPTO has published new patent grants:
```go
import "github.com/max-planck-innovation-competition/go-uspto/pkg/uspto"
...
// get all download links for bulk xml patent archives between the following dates
loc, _ := time.LoadLocation("Europe/Berlin")
start := time.Date(2021, 9, 1, 0, 0, 0, 0, loc)
end := time.Date(2021, 10, 1, 0, 0, 0, 0, loc)
res, err := uspto.GetPatentXmlBulkFileList(start, end)
```
Download a bulk zip file from the USPTO:
```go
exportFilePath, err := uspto.DownloadBulkFile("https://bulkdata.uspto.gov/data/patent/grant/redbook/fulltext/2021/ipg210907.zip", "./test-data")
```
Process the zip file
```go
err := uspto.ProcessBulkFile("./test-data/pg020101.zip", "./test-data/pg020101/xml")
```
Process the xml file
```go
patDoc, err := uspto.ProcessXMLFileSimple("./test-data/2-5-b1-patent.xml")
```
## PatentID
USPTO IDs are generated in the following way
## Patents
* Applications: application number: 4-digit year (starting in 2001) followed by 7 digits
### Applications
A Publication number includes a four-digit year, followed by a seven-digit sequence code
followed by a two-character Kind Code that is assigned by the USPTO.
The system displays the publication number with or without the "US" prefix and the Kind Code suffix
(e.g., `US YYYY-9999999 A9` or `9999-9999999`).
https://www.uspto.gov/patents/apply/applying-online/publication-number
* Re-examination utility patent number: B followed by up to 4 digits (issued before 01/02/2001)
## Trademarks
* Trademark application serial number: 8 digits
* Trademark reel and frame number: 4-digit reel followed by 4-digit frame
* Trademark registration number: up to 7 digits