Filter Command¶

The filter command fetches the latest delegated (or extended) stats and applies a chain of AND-combined filters in memory. It is the fastest way to narrow APNIC's full allocation list to a slice of interest — for example, all allocated IPv4 in a specific country, or every resource held by one opaque identifier.

Source: cmd_filter.go.

Filter Pipeline¶

filter builds a fluent chain: it fetches the chosen source, wraps it in a Filter / ExtendedFilter, applies each specified ByXxx step (each returns a new, narrowed filter), and finally calls Result(). Unspecified flags are skipped — the chain only contains the stages you ask for.

flowchart LR
    SRC["--source delegated|extended"] --> FETCH["fetch full stats<br/>(cached by --cache-ttl)"]
    FETCH --> NEW["NewFilter / NewExtendedFilter"]
    NEW --> C1{"--country set?"}
    C1 -- yes --> B1["ByCountry"]
    C1 -- no --> SKIP1["skip"]
    B1 --> C2{"--type set?"}
    SKIP1 --> C2
    C2 -- yes --> B2["ByType"]
    C2 -- no --> SKIP2["skip"]
    B2 --> C3{"--status set?"}
    SKIP2 --> C3
    C3 -- yes --> B3["ByStatus"]
    C3 -- no --> SKIP3["skip"]
    B3 --> C4{"--opaque-id set?<br/>(extended only)"}
    SKIP3 --> C4
    C4 -- yes --> B4["ByOpaqueID"]
    C4 -- no --> RES
    B4 --> RES["Result()"]
    RES --> OUT["human-readable / --json"]

apnic filter¶

Flags¶

Filters are combined with AND semantics: an entry must match every specified flag to survive. An unspecified flag imposes no constraint.

Source selection¶

--source delegated wraps the standard delegated stats in an apnic.Filter and supports --country, --type, --status. --source extended wraps the extended stats (which carry opaque-id) in an apnic.ExtendedFilter and additionally supports --opaque-id. Passing --opaque-id with --source delegated has no effect (the delegated file has no opaque-id column). An unknown --source value is an error.

Examples¶

# All allocated IPv4 in China
apnic filter --country CN --type ipv4 --status allocated

# Everything held by one APNIC organisation (extended)
apnic filter --source extended --country JP --opaque-id A92E1062

# All reserved IPv6, as JSON for jq
apnic --json filter --type ipv6 --status reserved | jq '.[0:10]'

# All ASN allocations in Australia
apnic filter --country AU --type asn

Output format (human-readable)¶

--source delegated:

# 312 entries after filter
CN  ipv4    1.0.1.0 256 allocated
CN  ipv4    1.0.2.0 512 allocated
...

Columns are tab-separated: Country Type Start Value Status.

--source extended adds a trailing opaque-id column:

# 87 entries after filter
JP  ipv4    133.0.0.0   65536   allocated   A92E1062
JP  ipv4    133.1.0.0   65536   allocated   A92E1062
...

Columns: Country Type Start Value Status OpaqueID.

Output (--json)¶

With --json, the full filtered slice is emitted — []DelegatedEntry for delegated, []DelegatedExtendedEntry for extended.

Filter Semantics¶

graph TB
    E["an entry"] --> A1{"--country?"}
    A1 -- "unset → pass" --> A2{"--type?"}
    A1 -- "match → pass" --> A2
    A2 -- "unset → pass" --> A3{"--status?"}
    A2 -- "match → pass" --> A3
    A3 -- "unset → pass" --> A4{"--opaque-id?"}
    A3 -- "match → pass" --> A4
    A4 -- "unset → pass" --> KEEP["keep in result"]
    A4 -- "match → pass" --> KEEP

Each stage is a no-op when its flag is unset, so apnic filter with no filters returns the entire source unchanged (subject to the source's own row order).

Global flags of note¶

Output summary¶