srapsware / domaindumper
Domain's state API and root database
Fund package maintenance!
NomadProgrammer
Patreon
Open Collective
Installs: 15
Dependents: 0
Suggesters: 0
Security: 0
Stars: 21
Watchers: 3
Forks: 1
Open Issues: 0
Language:TypeScript
Requires
- php: >=7.0
- curl/curl: ^2.0
README
A JavaScript library for accessing domain registration statistics via the DomainDumper API.
Installation
npm install domaindumper
Features
- Fetch registrar information and details
- Get TLD (Top Level Domain) details and lists
- Access domain registration statistics
- Country-based domain statistics
- Root zone database access
- Comprehensive error handling
Quick Start
import { getRegistrarsList, getRegistrarsDetails, getTldDetails, getTldsList, getDomainStats, getRootDatabase } from 'domaindumper'; // Basic usage example const registrars = await getRegistrarsList(); console.log(registrars);
API Reference
Registrar Operations
// Get basic registrar list const registrars = await getRegistrarsList(); /* Response: { "registrars": [ { "id": 1, "name": "Example Registrar", "url": "https://example.com" } ] } */ // Get detailed registrar information const details = await getRegistrarsDetails(); /* Response: { "registrars": [ { "id": 1, "name": "Example Registrar", "url": "https://example.com", "details": { // Additional registrar details } } ] } */
TLD Operations
// Get list of all TLDs const tldsList = await getTldsList(); /* Response: [ "com", "net", "org" ] */ // Get specific TLD details const tldInfo = await getTldDetails('com'); /* Response: { "name": "com", "type": "generic", "manager": "VeriSign Global Registry Services", "rootServers": [ "a.gtld-servers.net", "b.gtld-servers.net" ] } */ // Get root zone database const rootDb = await getRootDatabase(); /* Response: [ { "name": "com", "type": "generic", "manager": "VeriSign Global Registry Services" } ] */
Statistics Operations
// Get domain statistics for specific date const stats = await getDomainStats('2024', '02', '19'); /* Response: { "countryStats": { "US": 1000000, "GB": 500000 }, "registrarStats": { "1": 100000, "2": 50000 }, "tldStats": { "com": 2000000, "net": 1000000 } } */
Error Handling
try { const stats = await getDomainStats('2024', '02', '19'); } catch (error) { if (error.response) { console.error('API Error:', error.response.data.message); } else { console.error('Network Error:', error.message); } }
Testing
# Run all tests npm test # Run tests with coverage npm test -- --coverage
Development
# Install dependencies npm install # Build the package npm run build # Run tests npm test
API Documentation
Full API documentation is available at:
Support
- Documentation: https://statistics.domaindumper.com/docs
- Email: support@domaindumper.com
- Issues: GitHub Issues
License
MIT License - see the LICENSE file for details.