API Types¶

The apnic-skills SDK exposes a small set of strongly-typed Go structs that mirror the data returned by each APNIC service. Every fetcher method returns one of these types (or a slice of them), so understanding the type hierarchy is the key to working with the SDK.

All types live in the root package apnic (file models.go) and are returned ready-to-use: parsing, decompression and signature verification happen inside the SDK before the result reaches the caller.

Type Hierarchy¶

graph TB
    subgraph Stats["Delegated Stats Family"]
        DE["DelegatedEntry"]
        DER["DelegatedResult<br/>(Header+Summaries+Entries)"]
        EX["DelegatedExtendedEntry"]
        EXR["ExtendedResult"]
        ASG["AssignedEntry"]
        ASR["AssignedResult"]
        V6["IPv6AssignedEntry"]
        V6R["IPv6AssignedResult"]
        LG["LegacyEntry"]
        LGR["LegacyResult"]
        HDR["StatsFileHeader"]
        SM["StatsSummary"]
    end

    subgraph RDAP["RDAP Family"]
        RN["RDAPNetwork"]
        RA["RDAPAutnum"]
        RD["RDAPDomain"]
        RE["RDAPEntity"]
        RS["RDAPSearchResult"]
        RDS["RDAPDomainSearchResult"]
        RH["RDAPHelpInfo"]
        RNT["RDAPNotice"]
        RL["RDAPLink"]
        RVT["RDAPEvent"]
        RR["RDAPRemark"]
        C0["CIDR0"]
        RNS["RDAPNameserver"]
        RER["RDAPError"]
        RRSP["RDAPResponse<br/>(embedded base)"]
    end

    subgraph BGP["Thyme BGP Family"]
        BS["BGPSummary"]
        BK["BGPKeyValue"]
        BRT["BGPRawTable"]
        BR["BGPRoute"]
        BAM["BGPASNMap"]
        BBP["BGPBadPrefix"]
        BBPS["BGPBadPrefixes"]
        BPL["BGPPrefixLengthCount"]
        BPLS["BGPPerPrefixLength"]
        BUA["BGPUsedAutnum"]
        BUAS["BGPUsedAutnums"]
        BSP["BGPSparPrefix"]
        BSPS["BGPSparPrefixes"]
        SSP["BGPSinglePfxCount"]
        SSPX["BGPSinglePfx"]
    end

    subgraph IRR["IRR / RPSL Family"]
        IDB["IRRDatabase"]
        IOBJ["IRRObject"]
    end

    subgraph RPKI["RPKI / RRDP Family"]
        RN1["RRDPNotification"]
        RR1["RRDPRef"]
        RSN["RPKISnapshot"]
    end

    subgraph REx["REx Cross-RIR Family"]
        RXR["RExResource"]
        RXRR["RExResourcesResult"]
        RXH["RExHolder"]
        RXUN["RExUserNetwork"]
        RXC["RExHoldersCount"]
    end

    DER --> HDR
    DER --> SM
    DER --> DE
    EXR --> EX
    LGR --> LG
    BS --> BK
    BRT --> BR
    BBPS --> BBP
    BPLS --> BPL
    BUAS --> BUA
    BSPS --> BSP
    SSPX --> SSP
    IDB --> IOBJ
    RN1 --> RR1
    RN1 --> RR1
    RXRR --> RXR

    RN -. embeds .-> RRSP
    RA -. embeds .-> RRSP
    RD -. embeds .-> RRSP
    RS -. embeds .-> RRSP
    RDS -. embeds .-> RRSP
    RH -. embeds .-> RRSP

Category Overview¶

Conventions¶

• Time handling — every struct that carries a date uses Go time.Time, parsed from the APNIC source format (YYYY-MM-DD or RFC 3339). Callers never see raw date strings.
• Zero values — slices and maps are nil until populated; the SDK never returns a non-nil wrapper around a nil slice for "no data", it returns an empty slice where appropriate.
• JSON tags — RDAP and REx types carry json tags matching the wire format exactly; stats/BGP/IRR types are pure Go structs with no tags because their sources are pipe/whitespace-delimited text.
• CIDR helper — DelegatedEntry, DelegatedExtendedEntry and LegacyEntry each implement a CIDR() (string, error) method that converts the Start/Value pair into standard CIDR notation.

Sub-pages¶

• DelegatedEntry — Stats family: delegated, extended, assigned, IPv6-assigned, legacy.
• RDAP Types — Network, Autnum, Domain, Entity, Search results and shared sub-structs.
• BGP Types — All thyme BGP summary, route, prefix-length and SPAR structs.
• IRR Types — IRRDatabase / IRRObject and the 19 RPSL object types.
• RPKI Types — RRDP notification, snapshot, ref and publish/withdraw elements.
• REx Types — Cross-RIR resource, holder, user-network and count structs.