BGP Active Prefixes API

Introduction

Returns IPv4 or IPv6 address space routes/prefixes which are currently announced on BGP

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/prefixes-list

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/prefixes-list

Request

Parameter
bogonsOnly
Type
boolean
Required
Optional, default value: False
Description
Limit to bogon routes only or not
Parameter
batchSize
Type
integer (int32)
Required
Optional, default value: 10
Description
Requested batch size. Maximum value = 1000
Parameter
offset
Type
integer (int32)
Required
Optional, default value: 0
Description
Offset. Number of entries to skip
Parameter
sort
Type
string, enum (bgpPrefix, bgpPrefixNetworkAddress, bgpPrefixLastAddress, registryStatus, isBogon, isAnnounced, carriers)
Required
Optional, default value: bgpPrefixNetworkAddress
Description
Sort response by a field value. Default value: bgpPrefixNetworkAddress
Parameter
order
Type
string, enum (asc, desc)
Required
Optional, default value: asc
Description
Sort order. Default value: asc
Parameter
asn
Type
string
Required
Yes
Description
Autonomous System Number as numeric or ASN format (e.g. 123 or AS123 or ASN123)
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
isv4
Type
boolean
Required
Optional, default value: True
Description
Defines if the request is for ipv4 or ipv6 prefixes only. The 'false' value will make the response list ipv6 prefixes. When omitted, the ipv4 = 'true' value is assumed
Parameter
key
Type
string
Required
Yes
Description
Your API key

Responses

200
Success

Sample Query

GET
https://api-bdc.net/data/prefixes-list?bogonsOnly=false&batchSize=10&offset=0&localityLanguage=en&key=[YOUR API KEY]

Schema

application/json
totalinteger
Total prefixes found
offsetinteger
Number of entries skipped in result
batchinteger
Number of entries in the current batch
prefixesarray
Array of prefix entries returned
bgpPrefixstring
BGP prefix in CIDR format
bgpPrefixNetworkAddressstring
BGP prefix network (first) address
bgpPrefixLastAddressstring
BGP prefix last address
registryStatusstring
Registration status
isBogonboolean
Indicates whether the IP address is excluded from public Internet use by the authorities but announced into the global routing table via BGP
isAnnouncedboolean
Indicates whether the network was announced on BGP or not
carriersarray
List of Autonomous Systems (AS) announcing this prefix 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
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

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?