BigDataCloud Logo

Networks by CIDR API

Introduction

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.

Get Started

This API is part of the Network Engineering API Package and is available in free and paid plans. Please visit the Network Engineering API Package package page for limits and pricing information.

Endpoints

IPv4 only API Endpoint

Use this endpoint to force API calls routed over the IPv4 network only

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

Dual-Stack API Endpoint

This endpoint has native IPv6 support and backs the API calls routed over both IPv4 and IPv6 networks

GET
https://api-bdc.net/data/network-by-cidr

Request

Parameter
cidr
Type
string
Required
Yes
Description
CIDR range in a x.x.x.x/y format. Where x: (0-255), y: (0-32)
Parameter
depthLimit
Type
integer (int32)
Required
Optional, default value: 1
Description
Defines how many hierarchical levels down to include in the response
Parameter
localityLanguage
Type
string
Required
Optional, default value: en
Description
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
Parameter
subnetsBatchSize
Type
integer (int32)
Required
Optional, default value: 20
Description
number of subnetwork entries to retrieve. reads 20 if omitted, 20 is the hard limit
Parameter
subnetsOffset
Type
integer (int32)
Required
Optional, default value: 0
Description
the number of subnetwork entries to skip. reads 0 if omitted.
Parameter
key
Type
string
Required
Yes
Description
Your API key

Responses

200
Success

Sample Query

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

Schema

application/json
cidrstring
CIDR range to represent the response
parentstring
Parent network in CIDR format
networksarray
Array of a network/range objects resembling the CIDR range of interest. Omitted if a single network
Cidrstring
Cidr object
Typestring
Type object
network
network object
registrystring
The Regional Internet Registry (RIR), the network registered with
registryStatusstring
Registration status
registeredCountrystring
Registered Country ISO 3166-1 Alpha-2 code
registeredCountryNamestring
Registered Country name localised to the language is as defined by 'localityLanguage' request parameter
organisationstring
organisation or a segment the network is registered for
isReachableGloballyboolean
Indicates whether the network was announced on BGP and reachable globally or not
isBogonboolean
Indicates whether the IP address is excluded from public Internet use by the authorities but announced into the global routing table via BGP
bgpPrefixstring
The BGP prefix detected on the global network, announcing the network
bgpPrefixNetworkAddressstring
BGP prefix network (the first) address
bgpPrefixLastAddressstring
BGP prefix last address
totalAddressesstring
Total number of IP addresses in the Network
carriersarray
List of Autonomous Systems (AS) announcing this network on BGP
asnstring
Autonomous System Number string
asnNumericinteger
Autonomous System Number
organisationstring
Registered Organisation
namestring
Registered name
registrystring
The Regional Internet Registry (RIR) the AS is registered with
registeredCountrystring
Registered Country ISO 3166-1 Alpha-2 code
registeredCountryNamestring
Registered Country localised name. The language is as defined by the 'localityLanguage' request parameter
registrationDatestring
Registration date in 'yyyy-mm-dd' format
registrationLastChangestring
Registration modification date in 'yyyy-mm-dd' format
totalIpv4Addressesinteger
Total number of IP addresses announced by the AS
totalIpv4Prefixesinteger
Total number of ipV4 BGP prefixes announced by the AS
totalIpv4BogonPrefixesinteger
Total number of ipV4 bogon prefixes announced by the AS
totalIpv6Prefixesinteger
Total number of ipV6 BGP prefixes announced by the AS
totalIpv6BogonPrefixesinteger
Total number of ipV6 bogon prefixes announced by the AS
rankinteger
Global rank by total number of IP addresses announced
rankTextstring
Global rank by total number of IP addresses announced including total
viaCarriersarray
List of Autonomous Systems (AS) detected at the last hop before the announced parties. Capped to the most significant 5.
asnstring
Autonomous System Number string
asnNumericinteger
Autonomous System Number
organisationstring
Registered Organisation
namestring
Registered name
registrystring
The Regional Internet Registry (RIR) the AS is registered with
registeredCountrystring
Registered Country ISO 3166-1 Alpha-2 code
registeredCountryNamestring
Registered Country localised name. The language is as defined by the 'localityLanguage' request parameter
totalIpv4Addressesinteger
Total number of IP addresses announced by the AS
rankinteger
Global rank by total number of IP addresses announced
rankTextstring
Global rank by total number of IP addresses announced including total
totalSubnetsinteger
Total number of subnetworks detected
subnetsarray
The array of subnetwork objects
startAddressstring
First IPv4 address of the subnet. In string format
endAddressstring
Last IPv4 address of the subnet. In string format
isCellularboolean
Returns 'true' if the subnetwork was detected as servicing cellular network clients, omitted otherwise
organisationstring
Organisation or segment the network was registered for
registeredCountrystring
Registered Country ISO 3166-1 Alpha-2 code
registeredCountryNamestring
Registered Country name localised to the language as defined by 'localityLanguage' request parameter

Sample Response

JSON View
400
Bad request

Sample Response

JSON View
403
Access denied, or your quota limit has exceeded

Sample Response

JSON View
404
Found no valid entry for the request

Sample Response

JSON View
406
Found too many result items. Please reduce the scope of your request

Sample Response

JSON View
500
An error has occurred and did not complete your request. Please try again

Sample Response

JSON View
Was this page helpful?