Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lissy93/who-dat
🔎 A free no-CORS WHOIS/RDAP lookup API, for fetching domain registration info
https://github.com/lissy93/who-dat
api go public-api rdap whois
Last synced: 1 day ago
JSON representation
🔎 A free no-CORS WHOIS/RDAP lookup API, for fetching domain registration info
- Host: GitHub
- URL: https://github.com/lissy93/who-dat
- Owner: Lissy93
- License: mit
- Created: 2024-01-05T15:53:18.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T02:12:01.000Z (4 days ago)
- Last Synced: 2024-11-10T03:19:32.691Z (4 days ago)
- Topics: api, go, public-api, rdap, whois
- Language: Go
- Homepage: https://who-dat.as93.net
- Size: 355 KB
- Stars: 127
- Watchers: 5
- Forks: 21
- Open Issues: 2
-
Metadata Files:
- Readme: .github/README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Free & Open Source WHOIS Lookup Service
No-CORS, no auth API that's publicly available or easily self-hostable
🌐 who-dat.as93.net
---
Contents
- [API Usage](#api-usage)
- [Base URL](#base-url)
- [Endpoints](#endpoints)
- [Single Domain](#single-domain-lookup-domain)
- [Bulk Domains](#multiple-domain-lookup-multi)
- [Deployment](#deployment)
- [Option 1: Vercel](#option-1-vercel)
- [Option 2: Docker](#option-2-docker)
- [Option 3: Binary](#option-3-binary)
- [Option 4: Build from Source](#option-4-build-from-source)
- [Development](#development)
- [Contributing](#contributing)
- [Web Interface](#web-interface)
- [Mirror](#mirror)
- [Credits](#credits)
- [More Like This](#more-like-this)
- [License](#license)
## API Usage
> **TL;DR** Get the WHOIS records for a site: `curl https://who-dat.as93.net/example.com`
For detailed request + response schemas, and to try the API out, you can reference the [spec](https://who-dat.as93.net/docs.html)
### Base URL
The base URL for the public API is [`who-dat.as93.net`](https://who-dat.as93.net)
If you're self-hosting (recommended) then replace this with your own base URL.
### Endpoints
Single Domain Lookup /[domain]
- **URL**: `/[domain]`
- **Method**: `GET`
- **URL Params**: None
- **Success Response**:
- **Code**: 200
- **Content**: WHOIS data for the specified domain in JSON format.
- **Error Response**:
- **Code**: 400 BAD REQUEST
- **Content**: `{ "error": "Domain not specified" }`
- **Code**: 404 NOT FOUND
- **Content**: `{ "error": "Domain not found" }`
- **Sample Call**:
##### Command Line
```bash
curl https://who-dat.as93.net/example.com
```
##### JavaScript
```javascript
fetch('https://who-dat.as93.net/example.com')
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```
##### Python
```python
import requests
response = requests.get('https://who-dat.as93.net/example.com')
if response.status_code == 200:
print(response.json())
else:
print("Error:", response.status_code)
```
Multiple Domain Lookup /multi
- **URL**: `/multi`
- **Method**: `GET`
- **Query Params**:
- **domains**: A comma-separated list of domains.
- **Success Response**:
- **Code**: 200
- **Content**: Array of WHOIS data for the specified domains in JSON format.
- **Error Response**:
- **Code**: 400 BAD REQUEST
- **Content**: `{ "error": "No domains specified" }`
- **Code**: 500 INTERNAL SERVER ERROR
- **Content**: `{ "error": "[error message]" }`
- **Sample Call**:
```
curl "https://who-dat.as93.net/multi?domains=example.com,example.net"
```
[](https://who-dat.as93.net/docs.html)
---
## Deployment
#### Option 1: Vercel
This is the quickest and easiest way to get up-and-running. Simply fork the repository, then login to Vercel (using GitHub), and after importing your fork, it will be deployed! There's no additional config or keys needed, and it should work just fine on the free plan.
Alternatively, just hit the button below for 1-click deploy 👇
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flissy93%2Fwho-dat&demo-title=Who-Dat%20Demo&demo-url=https%3A%2F%2Fwho-dat.as93.net&demo-image=https%3A%2F%2Fi.ibb.co%2FJ5r1zCP%2Fwho-dat-square.png)
#### Option 2: Docker
The light-weight Docker image is published to DockerHub ([hub.docker.com/r/lissy93/who-dat](https://hub.docker.com/r/lissy93/who-dat)), as well as GHCR ([here](https://github.com/Lissy93/who-dat/pkgs/container/who-dat)).
Providing you've got Docker installed, you can get everything by running:
```shell
docker run -p 8080:8080 --dns 8.8.8.8 --dns 8.8.4.4 lissy93/who-dat
```
[](https://hub.docker.com/r/lissy93/who-dat)
#### Option 3: Binary
Head to the [Releases Tab](https://github.com/Lissy93/who-dat/releases), download and extract the pre-built executable for your system, then run it.
Example
If you're using the command line, you can do something like this
Don't forget to update (v1.0) with the version number you want, and (linux-amd64) with your system's architecture.
```bash
# Download the binary for your system (from releases tab)
wget https://github.com/Lissy93/who-dat/releases/download/v0.9/who-dat-v0.9-linux-amd64.tar.gz -O ./who-dat.tar.gz
# Extract the compressed file
tar -xzvf who-dat.tar.gz
# Make it executable
chmod +x who-dat
# Run Who-Dat!
./who-dat
```
(Or, if you're a Microsoft fanboy, you can just double-click the `who-dat.exe` after extracting in Windows Explorer)
#### Option 4: Build from Source
Follow the setup instructions in the [Development](#development) section.
Then run `go build -a -installsuffix cgo -o who-dat .` to generate the binary for your system.
You'll then be able to execute the newly built `./who-dat` file directly to start the application.
---
## Development
Prerequisites: You'll need [Go](https://go.dev/) and [Node](https://nodejs.org/) installed. You will likley also want [Git](https://git-scm.com/) and/or [Docker](https://www.docker.com/).
```
git clone [email protected]:Lissy93/who-dat.git
cd who-dat
go get
npm install
npm run build
```
Then run either `npx vercel dev`, or `go run main.go`
Alternativley, build the Docker container with `docker build -t who-dat .`
[](https://gitpod.io/#https://github.com/lissy93/who-dat)
[](https://codespaces.new/Lissy93/who-dat)
---
## Web Interface
There's a very simple frontend included in the app. This is built with Alpine.js, so is super light-weight, and only adds about 100kb to the total executable.
The web interface is used to view WHOIS records for a given domain, and also hosts the API documentation.
---
## Contributing
Contributions of any kind are welcome (and would be much appreciated!). Be sure to follow our [Code of Conduct](https://github.com/Lissy93/who-dat/blob/main/.github/CODE_OF_CONDUCT.md).
If you're new to open source, I've put together some guides in [Git-In](https://github.com/Lissy93/git-into-open-source/), but feel free to reach out if you need any support.
Not a coder? You can still help, by raising bugs you find, updating docs, or consider sponsoring me on GitHub
[](https://github.com/sponsors/Lissy93)
---
## Mirror
We've got a (non-Microsoft) mirror of this repository hosted on CodeBerg, at [codeberg.org/alicia/who-dat](https://codeberg.org/alicia/who-dat)
[](https://codeberg.org/alicia/who-dat)
---
## Credits
##### Inspiration
This project was inspired by [someshkar/whois-api](https://github.com/someshkar/whois-api) by [Somesh Kar](https://someshkar.com/).
##### Tech Credits
- The frontend is built with Alpine.js[^alpinejs], Vite[^vite], TS[^typescript] and SCSS[^scss] (plus the usual web tech stack).
- The backend is written in Go[^golang], and was made possible thanks to [json-iterator/go](https://github.com/json-iterator/go) and [likexian/whois-parser](https://github.com/likexian/whois-parser)
- Demo deployed to Vercel[^vercel] (but also available on DockerHub[^dockerhub]), and source of course on GitHub[^github] and CodeBerg[^codeberg].
[^alpinejs]: [Alpine.js](https://alpinejs.dev/) - A rugged, minimal framework for composing JavaScript behavior in your markup.
[^vite]: [Vite](https://vitejs.dev/) - A build tool that aims to provide a faster and leaner development experience for modern web projects.
[^typescript]: [TypeScript](https://www.typescriptlang.org/) - A typed superset of JavaScript that compiles to plain JavaScript.
[^scss]: [SCSS](https://sass-lang.com/) - A preprocessor scripting language that is interpreted or compiled into Cascading Style Sheets (CSS).
[^golang]: [Go Lang](https://golang.org/) - An open source programming language that makes it easy to build simple, reliable, and efficient software.
[^github]: [GitHub](https://github.com/) - A platform for version control and collaboration. It lets you and others work together on projects from anywhere.
[^codeberg]: [Codeberg](https://codeberg.org/) - A free and open-source forge for collaborative software development.
[^vercel]: [Vercel](https://vercel.com/) - Static hosting and shit
[^dockerhub]: [DockerHub](https://hub.docker.com/) - Container registry hosting and shit
##### Contributors
Alicia Bot
Alicia Sykes
Sammy LS
Phill Holland
##### Sponsors
Vincent Koc
Anand Chowdhary
Shrippen
Zach Biles
Ulises Gascón
Digital Archeology
InDieTasten
Araguaci
Brian McGonagill
Vlad
HeliXZz
Patrick Van Der Veken
Master Yoda
Göksel Yeşiller
Shiverme Timbers
Forward Email - Open-source & Privacy-focused Email Service (2023)
GT
Bastii717
Umbrel
HamburgerJung
Frankdez93
Terminal Trove
St617
Nrvo
---
## More Like This
You might be interested in [Web-Check](https://github.com/Lissy93/web-check), an all-in-one tool for fetching info on a given domain name.
If you like projects like these, consider [following me](https://github.com/Lissy93) on GitGub 😊
I'm often putting out new (free & open source) utilities, relating to security, privacy, OSINT, Linux and self-hosting.
---
## License
> _**[Lissy93/Who-Dat](https://github.com/Lissy93/who-dat)** is licensed under [MIT](https://github.com/Lissy93/who-dat/blob/HEAD/LICENSE) © [Alicia Sykes](https://aliciasykes.com) 2024._
> For information, see TLDR Legal > MIT
Expand License
```
The MIT License (MIT)
Copyright (c) Alicia Sykes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included install
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
© Alicia Sykes 2024
Licensed under MIT
Thanks for visiting :)
###### References
➧ See [Credits](#credits)
