Getting Started¶

Welcome to apnic-skills! This guide helps you get up and running with the APNIC Go SDK.

What is apnic-skills?¶

apnic-skills is a comprehensive Go SDK for APNIC (Asia-Pacific Network Information Centre) public data services. It provides:

Full coverage of all APNIC data endpoints (stats, RDAP, whois, IRR, RPKI/RRDP, thyme BGP, REx, transfers, changes, telemetry)
Anti-scraping built-in (browser mimicry, rate limiting, jitter)
Chunked download for large files (bypassing FTP throttling)
Chain filtering fluent API
Data integrity verification (MD5 + PGP)
CLI covering all SDK capabilities

Architecture at a Glance¶

flowchart TB
    subgraph You["Your Application"]
        Code["Go Code<br/>or<br/>CLI"]
    end

    subgraph SDK["apnic-skills"]
        Client["Client<br/>━━━━━━━━━━━━<br/>Fetch* methods<br/>Query* methods<br/>RDAP* methods"]

        subgraph Layers["Layers"]
            Public["Public API<br/>Fetch/Query/RDAP/Verify"]
            Internal["Internal<br/>fetchText/fetchReader<br/>doHTTPRequest"]
            Download["Download<br/>probeRange/downloadChunked<br/>fetchChunkWithRetry"]
        end

        Client --> Public --> Internal --> Download
    end

    subgraph Features["Cross-cutting"]
        Stealth["Browser Headers"]
        RateLimit["Token Bucket"]
        Cache["Cache (30min)"]
    end

    subgraph APNIC["APNIC"]
        Services["5 services<br/>ftp/rdap/thyme/rex/whois"]
    end

    Code --> Client
    Features -.-> Internal
    Download -->|HTTPS| APNIC

Where to Next?¶

Installation — Install the SDK and CLI
Quick Start — Your first query in 5 minutes
Configuration — Customize client behavior
SDK Reference — Browse the full API
CLI Reference — Learn the command-line tool
Workflows — Real-world usage patterns