BigDataCloud Logo
Documentation Pricing
Login
< Back to Documentation
On this page
Introduction
Get Started
Endpoint
Request
Responses

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 package and is available in free and paid plans. Please visit the Network Engineering 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
Type
Required
Description
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

Example query 

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

Example response

Schema

application/json