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.
Endpoint
GET
https://api-bdc.net/data/prefixes-list
Request
Parameter
Type
Required
Description
Parameter
bogonsOnlyType
booleanRequired
Optional, default value: FalseDescription
Limit to bogon routes only or notParameter
batchSizeType
integer (int32)Required
Optional, default value: 10Description
Requested batch size. Maximum value = 1000Parameter
offsetType
integer (int32)Required
Optional, default value: 0Description
Offset. Number of entries to skipParameter
sortType
string, enum (bgpPrefix, bgpPrefixNetworkAddress, bgpPrefixLastAddress, registryStatus, isBogon, isAnnounced, carriers)Required
Optional, default value: bgpPrefixNetworkAddressDescription
Sort response by a field value. Default value: bgpPrefixNetworkAddressParameter
orderType
string, enum (asc, desc)Required
Optional, default value: ascDescription
Sort order. Default value: ascParameter
asnType
stringRequired
YesDescription
Autonomous System Number as numeric or ASN format (e.g. 123 or AS123 or ASN123)Parameter
localityLanguageType
stringRequired
Optional, default value: enDescription
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 namesParameter
isv4Type
booleanRequired
Optional, default value: TrueDescription
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 assumedParameter
keyType
stringRequired
YesDescription
Your API keyResponses
200OK
200
OK
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
totalintegerTotal prefixes found
totalinteger
Total prefixes found
offsetintegerNumber of entries skipped in result
offsetinteger
Number of entries skipped in result
batchintegerNumber of entries in the current batch
batchinteger
Number of entries in the current batch
prefixesarrayArray of prefix entries returned
prefixesarray
Array of prefix entries returned
bgpPrefixstringBGP prefix in CIDR format
bgpPrefixstring
BGP prefix in CIDR format
bgpPrefixNetworkAddressstringBGP prefix network (first) address
bgpPrefixNetworkAddressstring
BGP prefix network (first) address
bgpPrefixLastAddressstringBGP prefix last address
bgpPrefixLastAddressstring
BGP prefix last address
registryStatusstringRegistration status
registryStatusstring
Registration status
isBogonbooleanIndicates whether the IP address is excluded from public Internet use
by the authorities but announced into the global routing table via BGP
isBogonboolean
Indicates whether the IP address is excluded from public Internet use
by the authorities but announced into the global routing table via BGP
isAnnouncedbooleanIndicates whether the network was announced on BGP or not
isAnnouncedboolean
Indicates whether the network was announced on BGP or not
carriersarrayList of Autonomous Systems (AS) announcing this prefix on BGP
carriersarray
List of Autonomous Systems (AS) announcing this prefix on BGP
asnstringAutonomous System Number string
asnstring
Autonomous System Number string
asnNumericintegerAutonomous System Number
asnNumericinteger
Autonomous System Number
organisationstringRegistered Organisation
organisationstring
Registered Organisation
namestringRegistered name
namestring
Registered name
registrystringThe Regional Internet Registry (RIR) the AS is registered with
registrystring
The Regional Internet Registry (RIR) the AS is registered with
registeredCountrystringRegistered Country ISO 3166-1 Alpha-2 code
registeredCountrystring
Registered Country ISO 3166-1 Alpha-2 code
registeredCountryNamestringRegistered Country localised name. The language is as defined by the 'localityLanguage' request parameter
registeredCountryNamestring
Registered Country localised name. The language is as defined by the 'localityLanguage' request parameter
totalIpv4AddressesintegerTotal number of IP addresses announced by the AS
totalIpv4Addressesinteger
Total number of IP addresses announced by the AS
rankintegerGlobal rank by total number of IP addresses announced
rankinteger
Global rank by total number of IP addresses announced
rankTextstringGlobal rank by total number of IP addresses announced including total
rankTextstring
Global rank by total number of IP addresses announced including total
Sample Response
JSON View
400Bad request
400
Bad request
Sample Response
JSON View
403Access denied, or your quota limit has exceeded
403
Access denied, or your quota limit has exceeded
Sample Response
JSON View
404Found no valid entry for the request
404
Found no valid entry for the request
Sample Response
JSON View
406Found too many result items. Please reduce the scope of your request
406
Found too many result items. Please reduce the scope of your request
Sample Response
JSON View
500An error has occurred and did not complete your request. Please try again
500
An error has occurred and did not complete your request. Please try again
Sample Response
JSON View
Was this page helpful?