Networks by CIDR API

The CIDR Networks API retrieves a list of all the networks currently being announced on the Border Gateway Protocol (BGP) within a particular CIDR range.

GEThttps://api-bdc.net/data/network-by-cidr

Parameters

Parameter	Type	Required	Description
`cidr`	string	Optional	CIDR range in an x.x.x.x/y format. Where x: (0-255), y: (0-32)
`depthLimit`	integer (int32)	Optional	Defines how many hierarchical levels down to include in the response
`localityLanguage`	string	Optional	Preferred language for locality names in ISO 639-1 format, such as 'en' for English, 'es' for Spanish etc. If the requested language is not available for a requested location, it will default to English. If no English variant is known, will provide the native, local names
`subnetsBatchSize`	integer (int32)	Optional	Number of subnetwork entries to retrieve. Defaults to 20 if omitted; 20 is the hard limit
`subnetsOffset`	integer (int32)	Optional	The number of subnetwork entries to skip. Defaults to 0 if omitted
`key`	string	Optional	Your API key

Responses

200OK

Sample Request

https://api-bdc.net/data/network-by-cidr?cidr=8.0.0.0/8&depthLimit=2&bogonsOnly=false&localityLanguage=en&key=[YOUR API KEY]

Sample Response

JSON View

Response Schema

cidrstringThe requested CIDR range (e.g. "1.1.1.0/24").

parentstringParent network in CIDR format

▶networksarrayArray of network objects that together cover the requested CIDR range. Present only when the range spans multiple BGP prefixes.

CidrstringCidr object

TypestringType object

▶networkobjectnetwork object

registrystringThe Regional Internet Registry (RIR) that administers the network block (e.g. ARIN, RIPE, APNIC, LACNIC, AFRINIC, IANA).

registryStatusstringThe registration status of the network block as recorded by the RIR (e.g. "assigned", "allocated", "reserved").

registeredCountrystringRegistered Country ISO 3166-1 Alpha-2 code

registeredCountryNamestringRegistered Country name localised to the language is as defined by 'localityLanguage' request parameter

organisationstringThe organisation or entity the network block is registered for, as recorded in the RIR database.

isReachableGloballybooleanIndicates whether the network was announced on BGP and reachable globally or not

isBogonbooleanIndicates whether the IP address is excluded from public Internet use by the authorities but announced into the global routing table via BGP

bgpPrefixstringThe BGP prefix detected on the global network, announcing the network

bgpPrefixNetworkAddressstringThe first (network) address of the BGP prefix range.

bgpPrefixLastAddressstringThe last (broadcast) address of the BGP prefix range.

totalAddressesintegerNumber of IP addresses in the Network. For IPv6 networks, the value can range up to a 128-bit unsigned integer

▶carriersarrayList of Autonomous Systems (AS) announcing this network on BGP

asnstringThe Autonomous System Number in prefixed string format (e.g. "AS13335").

asnNumericintegerThe Autonomous System Number as an unsigned integer (e.g. 13335).

organisationstringThe organisation or entity the AS is registered for, as recorded in the RIR database.

namestringThe short handle or network name assigned to the AS by the RIR (e.g. "CLOUDFLARENET").

registrystringThe Regional Internet Registry (RIR) the AS is registered with

registeredCountrystringRegistered Country ISO 3166-1 Alpha-2 code

registeredCountryNamestringRegistered Country localised name. The language is as defined by the 'localityLanguage' request parameter

registrationDatestringRegistration date in 'yyyy-mm-dd' format

registrationLastChangestringRegistration modification date in 'yyyy-mm-dd' format

totalIpv4AddressesintegerTotal number of IP addresses announced by the AS

totalIpv4PrefixesintegerTotal number of ipV4 BGP prefixes announced by the AS

totalIpv4BogonPrefixesintegerTotal number of ipV4 bogon prefixes announced by the AS

totalIpv6PrefixesintegerTotal number of ipV6 BGP prefixes announced by the AS

totalIpv6BogonPrefixesintegerTotal number of ipV6 bogon prefixes announced by the AS

rankintegerGlobal rank by total number of IP addresses announced

rankTextstringHuman-readable global rank string including the total number of ranked ASNs (e.g. "#297 out of 79,835").

▶viaCarriersarrayList of Autonomous Systems (AS) detected at the last BGP hop before the network carriers. Capped to the 5 most significant upstream peers.