https://github.com/mrz1836/go-pipl
👨👩👦 Unofficial golang SDK for the pipl.com API
https://github.com/mrz1836/go-pipl
api go golang gomodule pipl pipl-test wrapper
Last synced: 4 months ago
JSON representation
👨👩👦 Unofficial golang SDK for the pipl.com API
- Host: GitHub
- URL: https://github.com/mrz1836/go-pipl
- Owner: mrz1836
- License: mit
- Created: 2019-06-09T01:30:34.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2026-02-05T21:00:37.000Z (4 months ago)
- Last Synced: 2026-02-06T07:00:16.513Z (4 months ago)
- Topics: api, go, golang, gomodule, pipl, pipl-test, wrapper
- Language: Go
- Homepage: https://docs.pipl.com/docs/getting-started
- Size: 1.63 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
- Agents: .github/AGENTS.md
Awesome Lists containing this project
README
# 👨👩👦 go-pipl
**The unofficial golang SDK for the [pipl.com API](https://pipl.com/api/).**
CI / CD
Quality
Security
Community
### Project Navigation
🚀 Installation
🧪 Examples & Tests
📚 Documentation
🤝 Contributing
🛠️ Code Standards
⚡ Benchmarks
🤖 AI Usage
⚖️ License
👥 Maintainers
## Installation
**go-pipl** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get github.com/mrz1836/go-pipl
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/mrz1836/go-pipl?tab=doc)
> **Heads up!** `go-pipl` is intentionally light on dependencies. The only
external package it uses is the excellent `testify` suite—and that's just for
our tests. You can drop this library into your projects without dragging along
extra baggage.
### Features
- Complete coverage for the [pipl.com API](https://pipl.com/api/)
- [Client](client.go) is completely configurable
- Minimum criteria detection before submitting a pipl query
- Search by pipl pointer reference
- Search for a single person via any of the following:
- Full Name
- Full Street Address
- Email
- Phone
- Username or UserID or URL
- Search **all possible people**
- Returns the original full person record
- Searches all possible persons and gets full details
- Combines all persons into one single response
- Thumbnail configuration setting for `person.Images`
- Adds `image.ThumbnailURL` with the complete url for a live thumbnail
- Test and example coverage for all methods
### Additional Documentation & Repository Management
Development Setup (Getting Started)
Install [MAGE-X](https://github.com/mrz1836/mage-x) build tool for development:
```bash
# Install MAGE-X for development and building
go install github.com/mrz1836/mage-x/cmd/magex@latest
magex update:install
```
Library Deployment
This project uses [goreleaser](https://github.com/goreleaser/goreleaser) for streamlined binary and library deployment to GitHub. To get started, install it via:
```bash
brew install goreleaser
```
The release process is defined in the [.goreleaser.yml](.goreleaser.yml) configuration file.
Then create and push a new Git tag using:
```bash
magex version:bump bump=patch push=true branch=master
```
This process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.
Build Commands
View all build commands
```bash script
magex help
```
GitHub Workflows
All workflows are driven by modular configuration in [`.github/env/`](.github/env/README.md) — no YAML editing required.
**[View all workflows and the control center →](.github/docs/workflows.md)**
Updating Dependencies
To update all dependencies (Go modules, linters, and related tools), run:
```bash
magex deps:update
```
This command ensures all dependencies are brought up to date in a single step, including Go modules and any managed tools. It is the recommended way to keep your development environment and CI in sync with the latest versions.
## Examples & Tests
All unit tests and fuzz tests run via [GitHub Actions](https://github.com/mrz1836/go-pre-commit/actions) and use [Go version 1.24.x](https://go.dev/doc/go1.24). View the [configuration file](.github/workflows/fortress.yml).
Run all tests (fast):
```bash script
magex test
```
Run all tests with race detector (slower):
```bash script
magex test:race
```
## Benchmarks
Run the Go benchmarks:
```bash script
magex bench
```
## Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## 🤖 AI Usage & Assistant Guidelines
Read the [AI Usage & Assistant Guidelines](.github/tech-conventions/ai-compliance.md) for details on how AI is used in this project and how to interact with the AI assistants.
## Maintainers
| [
](https://github.com/mrz1836) |
|:------------------------------------------------------------------------------------------------:|
| [MrZ](https://github.com/mrz1836) |
## Contributing
View the [contributing guidelines](.github/CONTRIBUTING.md) and please follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
### How can I help?
All kinds of contributions are welcome :raised_hands:!
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:.
You can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/mrz1836) :clap:
or by making a [**bitcoin donation**](https://mrz1818.com/?tab=tips&utm_source=github&utm_medium=sponsor-link&utm_campaign=go-pipl&utm_term=go-pipl&utm_content=go-pipl) to ensure this journey continues indefinitely! :rocket:
[](https://github.com/mrz1836/go-pipl/stargazers)
## License
[](LICENSE)