Networks by CIDR API | BigDataCloud

JavaScript seems to be disabled in your browser. For the best experience on our site, be sure to turn on Javascript in your browser.

Introduction

This API returns all the networks that are currently announced on Border Gateway Protocol (BGP) within a specified CIDR range.

Update Rate

BGP data: updated every 2 hours
Registry data: updated at least once a day

Try It Now

Use the form below to try out this API.

Parameters

Parameter	Type	Your Input Value
cidr	string
depthLimit	integer
bogonsOnly	boolean
asn	string
key	string	Don't have an API Key? Click here to register and get your free API Key If you already have a BigDataCloud account, you can log in to automatically fill this field with your Api Key.

Curl

curl -X GET --header 'Accept: application/json' 'https://api.bigdatacloud.net/data/network-by-cidr'

Request URL

https://api.bigdatacloud.net/data/network-by-cidr

Response

Awaiting request submission...

API Pricing

Monthly Subscription

FREE 10,000 queries/month

Additional 10,000 queries US$1.00/month

Add To My Subscription
Annual Subscription

FREE 10,000 queries/month

Additional 10,000 queries US$0.80/month

Add To My Subscription

API Endpoint

Endpoint:	/data/network-by-cidr
Full URL:	https://api.bigdatacloud.net/data/network-by-cidr

Request Format

Order	Parameter	Required	Data type	Description
1	cidr	Yes	string	CIDR range in a x.x.x.x/y format. Where x: (0-255), y: (0-32)
2	depthLimit	Yes	integer	Defines how many hierarchical levels down to include in the response
3	bogonsOnly	No	boolean	Limit to bogon routes only or not. Default – no limit
4	asn	No	string	Limit to ASN as a numeric or textual name format (e.g. 123 or AS123 or ASN123). Default – no limit
5	key	Yes	string	Your API key

Response Format

Field	Data type	Description
cidr	string	CIDR range to represent the response
parent	string	Parent network in CIDR format
networks	Array of <Range/Network> objects	Array of a network/range objects resembling the CIDR range of interest. Omitted if a single network
network	<Network> object	Network details. Omitted if multiple networks

Data Objects

Network object

Field	Data type	Description
registry	string	The Regional Internet Registry (RIR) the network is registered with
registryStatus	string	Registration status
registeredCountry	string	Registered Country ISO 3166-1 Alpha-2 code
registeredCountryName	string	Registered Country ISO 3166-1 name
organisation	string	Registered for
isReachableGlobally	boolean	Indicates if the network was announced on BGP and reachable globally or not
isBogon	boolean	Indicates if the network in bogon
bgpPrefix	string	The latest BGP prefix announcement for the current network
bgpPrefixNetworkAddress	string	BGP prefix network (the first) address
bgpPrefixLastAddress	string	BGP prefix last address
totalAddresses	32 bit unsigned integer	Total number of IP addresses in the Network
carriers	Array of <Carrier> objects	List of Autonomous Systems (AS) announcing this network on BGP
viaCarriers	Array of <Carrier> objects	List of Autonomous Systems (AS) detected at the last hop before the announced parties

Subnet object

Field	Data type	Description
startAddress	string	First IPv4 address of the subnet. In string format
endAddress	string	Last IPv4 address of the subnet. In string format
organisation	string	Registered for
registeredCountry	string	Registered Country ISO 3166-1 Alpha-2 code
registeredCountryName	string	Registered Country ISO 3166-1 name

Carrier object

Field	Data type	Description
asn	string	Autonomous System Number string
asnNumeric	32 bit unsigned integer	Autonomous System Number
organisation	string	Registered Organisation
name	string	Registered name
registry	string	The Regional Internet Registry (RIR) the AS is registered with
registeredCountry	string	Registered Country ISO 3166-1 Alpha-2 code
registeredCountryName	string	Registered Country ISO 3166-1 name
registrationDate	string	Registration date in “yyyy-mm-dd” format
registrationLastChange	string	Registration modification date in “yyyy-mm-dd” format
totalIpv4Addresses	32 bit unsigned integer	Total number of IP addresses announced by the AS
totalIpv4Prefixes	32 bit unsigned integer	Total number of BGP prefixes announced by the AS
totalIpv4BogonPrefixes	32 bit unsigned integer	Total number of bogon prefixes announced by the AS
rank	32 bit unsigned integer	World rank by total number of IP addresses announced
rankText	string	World rank by total number of IP addresses announced including total

CarrierShort object

Field	Data type	Description
asn	string	Autonomous System Number string
asnNumeric	32 bit unsigned integer	Autonomous System Number
organisation	string	Registered Organisation
name	string	Registered name
registry	string	The Regional Internet Registry (RIR) the AS is registered with
registeredCountry	string	Registered Country ISO 3166-1 Alpha-2 code
registeredCountryName	string	Registered Country ISO 3166-1 name
rank	32 bit unsigned integer	World rank by total number of IP addresses announced

Range/Network object

Field	Data type	Description	Range	Network
cidr	string	CIDR range to represent the range/network	X	X
type	string	Object type. Possible values: network, range	X	X
isBogon	boolean	Indicates if the network in bogon		X
carriers	Array of <Carrier short> objects	List of Autonomous Systems (AS) announcing this network on BGP		X
deepCount	32 bit integer	Indicates how many range or network objects are located downstream to the CIDR	X
totalAnnounced	32 bit unsigned integer	Indicates of how many IPv4 addresses in total has been announced within this CIDR	X
size	32 bit unsigned integer	Total size of the CIDR in IPv4 addresses	X
bogonsCount	32 bit unsigned integer	Indicates of how many IPv4 addresses has been announced within this CIDR at a bogon address space	X
subnets	Array of <Range/Network> objects	Array of the child Range/Network objects	X

Related APIs