API Reference

Radar

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Entities

Get IP address details

client.radar.entities.get(EntityGetParams { ip, format } query, RequestOptionsoptions?): EntityGetResponse { ip }

GET/radar/entities/ip

ModelsExpand Collapse

EntityGetResponse { ip }

ip: IP { asn, asnLocation, asnName, 5 more }

asn: string

asnLocation: string

asnName: string

asnOrgName: string

ip: string

ipVersion: string

location: string

locationName: string

EntitiesASNs

List autonomous systems

client.radar.entities.asns.list(ASNListParams { asn, format, limit, 3 more } query?, RequestOptionsoptions?): ASNListResponse { asns }

GET/radar/entities/asns

Get AS details by ASN

client.radar.entities.asns.get(numberasn, ASNGetParams { format } query?, RequestOptionsoptions?): ASNGetResponse { asn }

GET/radar/entities/asns/{asn}

Get AS-level relationships by ASN

client.radar.entities.asns.rel(numberasn, ASNRelParams { asn2, format } query?, RequestOptionsoptions?): ASNRelResponse { meta, rels }

GET/radar/entities/asns/{asn}/rel

Get IRR AS-SETs that an AS is a member of

client.radar.entities.asns.asSet(numberasn, ASNAsSetParams { format } query?, RequestOptionsoptions?): ASNAsSetResponse { as_sets, paths }

GET/radar/entities/asns/{asn}/as_set

Get AS details by IP address

client.radar.entities.asns.ip(ASNIPParams { ip, format } query, RequestOptionsoptions?): ASNIPResponse { asn }

GET/radar/entities/asns/ip

Get AS rankings by botnet threat feed activity

client.radar.entities.asns.botnetThreatFeed(ASNBotnetThreatFeedParams { asn, compareDateRange, date, 6 more } query?, RequestOptionsoptions?): ASNBotnetThreatFeedResponse { ases, meta }

GET/radar/entities/asns/botnet_threat_feed

ModelsExpand Collapse

ASNListResponse { asns }

asns: Array<ASN>

asn: number

country: string

countryName: string

name: string

aka?: string

orgName?: string

website?: string

ASNGetResponse { asn }

asn: ASN { asn, confidenceLevel, country, 8 more }

asn: number

confidenceLevel: number

country: string

countryName: string

estimatedUsers: EstimatedUsers { locations, estimatedUsers }

locations: Array<Location>

locationAlpha2: string

locationName: string

estimatedUsers?: number

Estimated users per location.

estimatedUsers?: number

Total estimated users.

name: string

orgName: string

related: Array<Related>

asn: number

name: string

aka?: string

estimatedUsers?: number

Total estimated users.

source: string

Regional Internet Registry.

website: string

aka?: string

ASNRelResponse { meta, rels }

meta: Meta { data_time, query_time, total_peers }

data_time: string

query_time: string

total_peers: number

rels: Array<Rel>

asn1: number

asn1_country: string

asn1_name: string

asn2: number

asn2_country: string

asn2_name: string

rel: string

ASNAsSetResponse { as_sets, paths }

as_sets: Array<AsSet>

as_members_count: number

The number of AS members in the AS-SET

as_set_members_count: number

The number of AS-SET members in the AS-SET

as_set_upstreams_count: number

The number of recursive upstream AS-SETs

asn_cone_size: number

The number of unique ASNs in the AS-SETs recursive downstream

irr_sources: Array<string>

The IRR sources of the AS-SET

name: string

The name of the AS-SET

hierarchical_asn?: number

The AS number following hierarchical AS-SET name

inferred_asn?: number

The inferred AS number of the AS-SET

peeringdb_asn?: number

The AS number matching PeeringDB record

paths: Array<Array<string>>

Paths from the AS-SET that include the given AS to its upstreams recursively

ASNIPResponse { asn }

asn: ASN { asn, country, countryName, 7 more }

asn: number

country: string

countryName: string

estimatedUsers: EstimatedUsers { locations, estimatedUsers }

locations: Array<Location>

locationAlpha2: string

locationName: string

estimatedUsers?: number

Estimated users per location.

estimatedUsers?: number

Total estimated users.

name: string

orgName: string

related: Array<Related>

asn: number

name: string

aka?: string

estimatedUsers?: number

Total estimated users.

source: string

Regional Internet Registry.

website: string

aka?: string

ASNBotnetThreatFeedResponse { ases, meta }

ases: Array<Ase>

asn: number

country: string

name: string

rank: number

rankChange?: number

meta: Meta { date, total, compareDate }

date: string

total: number

compareDate?: string

EntitiesLocations

List locations

client.radar.entities.locations.list(LocationListParams { continent, format, limit, 4 more } query?, RequestOptionsoptions?): LocationListResponse { locations }

GET/radar/entities/locations

Get location details

client.radar.entities.locations.get(stringlocation, LocationGetParams { format } query?, RequestOptionsoptions?): LocationGetResponse { location }

GET/radar/entities/locations/{location}

ModelsExpand Collapse

LocationListResponse { locations }

locations: Array<Location>

alpha2: string

continent: string

latitude: string

A numeric string.

longitude: string

A numeric string.

name: string

region: string

subregion: string

LocationGetResponse { location }

location: Location { alpha2, confidenceLevel, continent, 5 more }

alpha2: string

confidenceLevel: number

continent: string

latitude: string

A numeric string.

longitude: string

A numeric string.

name: string

region: string

subregion: string