APIs.io Engineering Platform Radar Entities API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Radar Entities API
  version: 4.0.0
tags:
- name: Radar Entities
paths:
  /radar/entities/asns:
    get:
      description: Gets a list of autonomous systems (AS).
      operationId: radar-get-entities-asn-list
      parameters:
      - description: Limit the number of objects in the response.
        in: query
        name: limit
        schema:
          description: Limit the number of objects in the response.
          example: 5
          type: integer
      - description: Number of objects to skip before grabbing results.
        in: query
        name: offset
        schema:
          description: Number of objects to skip before grabbing results.
          type: integer
      - description: Comma separated list of ASNs.
        in: query
        name: asn
        schema:
          description: Comma separated list of ASNs.
          example: 174,7922
          type: string
      - description: Location Alpha2 to filter results.
        in: query
        name: location
        schema:
          description: Location Alpha2 to filter results.
          example: US
          type: string
      - description: Order asn list.
        in: query
        name: orderBy
        schema:
          default: ASN
          description: Order asn list.
          enum:
          - ASN
          - POPULATION
          type: string
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asns:
                        items:
                          properties:
                            aka:
                              type: string
                            asn:
                              example: 714
                              type: integer
                            country:
                              example: GB
                              type: string
                            countryName:
                              example: United Kingdom
                              type: string
                            name:
                              example: Apple Inc.
                              type: string
                            nameLong:
                              description: Deprecated field. Please use 'aka'.
                              type: string
                            orgName:
                              type: string
                            website:
                              example: https://www.apple.com/support/systemstatus/
                              type: string
                          required:
                          - name
                          - asn
                          - country
                          - countryName
                          type: object
                        type: array
                    required:
                    - asns
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                - result
                - success
                - errors
                type: object
          description: Bad Request
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get autonomous systems
      tags:
      - Radar Entities
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/asns/{asn}:
    get:
      description: Get the requested autonomous system information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).
      operationId: radar-get-entities-asn-by-id
      parameters:
      - description: Autonomous System Number (ASN).
        in: path
        name: asn
        required: true
        schema:
          description: Autonomous System Number (ASN).
          example: 3
          type: integer
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asn:
                        properties:
                          aka:
                            type: string
                          asn:
                            example: 714
                            type: integer
                          confidenceLevel:
                            example: 5
                            type: integer
                          country:
                            example: GB
                            type: string
                          countryName:
                            example: United Kingdom
                            type: string
                          estimatedUsers:
                            properties:
                              estimatedUsers:
                                description: Total estimated users
                                example: 86099
                                type: integer
                              locations:
                                items:
                                  properties:
                                    estimatedUsers:
                                      description: Estimated users per location
                                      example: 16710
                                      type: integer
                                    locationAlpha2:
                                      example: US
                                      type: string
                                    locationName:
                                      example: United States
                                      type: string
                                  required:
                                  - locationName
                                  - locationAlpha2
                                  type: object
                                type: array
                            required:
                            - locations
                            type: object
                          name:
                            example: Apple Inc.
                            type: string
                          nameLong:
                            description: Deprecated field. Please use 'aka'.
                            type: string
                          orgName:
                            type: string
                          related:
                            items:
                              properties:
                                aka:
                                  type: string
                                asn:
                                  example: 174
                                  type: integer
                                estimatedUsers:
                                  description: Total estimated users
                                  example: 65345
                                  type: integer
                                name:
                                  example: Cogent-174
                                  type: string
                              required:
                              - name
                              - asn
                              type: object
                            type: array
                          source:
                            description: Regional Internet Registry
                            example: RIPE
                            type: string
                          website:
                            example: https://www.apple.com/support/systemstatus/
                            type: string
                        required:
                        - name
                        - country
                        - countryName
                        - confidenceLevel
                        - related
                        - source
                        - asn
                        - website
                        - orgName
                        - estimatedUsers
                        type: object
                    required:
                    - asn
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                - error
                type: object
          description: Not found
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get autonomous system information by AS number
      tags:
      - Radar Entities
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/asns/{asn}/rel:
    get:
      description: Get AS-level relationship for given networks.
      operationId: radar-get-asns-rel
      parameters:
      - description: Get all ASNs with provider-customer or peering relationships with the given ASN
        in: path
        name: asn
        required: true
        schema:
          description: Get all ASNs with provider-customer or peering relationships with the given ASN
          example: 3
          type: integer
      - description: Get the AS relationship of ASN2 with respect to the given ASN
        in: query
        name: asn2
        schema:
          description: Get the AS relationship of ASN2 with respect to the given ASN
          type: integer
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      meta:
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                        - data_time
                        - query_time
                        - total_peers
                        type: object
                      rels:
                        items:
                          properties:
                            asn1:
                              type: integer
                            asn1_country:
                              type: string
                            asn1_name:
                              type: string
                            asn2:
                              type: integer
                            asn2_country:
                              type: string
                            asn2_name:
                              type: string
                            rel:
                              type: string
                          required:
                          - asn1
                          - asn1_country
                          - asn1_name
                          - asn2
                          - asn2_country
                          - asn2_name
                          - rel
                          type: object
                        type: array
                    required:
                    - rels
                    - meta
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                - result
                - success
                - errors
                type: object
          description: Bad Request
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get AS-level relationships by AS number
      tags:
      - Radar Entities
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/asns/ip:
    get:
      description: Get the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).
      operationId: radar-get-entities-asn-by-ip
      parameters:
      - description: IP address.
        in: query
        name: ip
        required: true
        schema:
          description: IP address.
          example: 8.8.8.8
          type: string
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      asn:
                        properties:
                          aka:
                            type: string
                          asn:
                            example: 714
                            type: integer
                          country:
                            example: GB
                            type: string
                          countryName:
                            example: United Kingdom
                            type: string
                          estimatedUsers:
                            properties:
                              estimatedUsers:
                                description: Total estimated users
                                example: 86099
                                type: integer
                              locations:
                                items:
                                  properties:
                                    estimatedUsers:
                                      description: Estimated users per location
                                      example: 16710
                                      type: integer
                                    locationAlpha2:
                                      example: US
                                      type: string
                                    locationName:
                                      example: United States
                                      type: string
                                  required:
                                  - locationName
                                  - locationAlpha2
                                  type: object
                                type: array
                            required:
                            - locations
                            type: object
                          name:
                            example: Apple Inc.
                            type: string
                          nameLong:
                            description: Deprecated field. Please use 'aka'.
                            type: string
                          orgName:
                            type: string
                          related:
                            items:
                              properties:
                                aka:
                                  type: string
                                asn:
                                  type: integer
                                estimatedUsers:
                                  description: Total estimated users
                                  example: 65345
                                  type: integer
                                name:
                                  type: string
                              required:
                              - name
                              - asn
                              type: object
                            type: array
                          source:
                            description: Regional Internet Registry
                            example: RIPE
                            type: string
                          website:
                            example: https://www.apple.com/support/systemstatus/
                            type: string
                        required:
                        - name
                        - country
                        - countryName
                        - related
                        - asn
                        - website
                        - orgName
                        - source
                        - estimatedUsers
                        type: object
                    required:
                    - asn
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                - error
                type: object
          description: Not found
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get autonomous system information by IP address
      tags:
      - Radar Entities
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/ip:
    get:
      description: 'Get IP address information. '
      operationId: radar-get-entities-ip
      parameters:
      - description: IP address.
        in: query
        name: ip
        required: true
        schema:
          description: IP address.
          example: 8.8.8.8
          type: string
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      ip:
                        properties:
                          asn:
                            example: '15169'
                            type: string
                          asnLocation:
                            example: US
                            type: string
                          asnName:
                            example: GOOGLE
                            type: string
                          asnOrgName:
                            example: Google LLC
                            type: string
                          ip:
                            example: 8.8.8.8
                            type: string
                          ipVersion:
                            example: IPv4
                            type: string
                          location:
                            example: GB
                            type: string
                          locationName:
                            example: United Kingdom
                            type: string
                        required:
                        - ip
                        - ipVersion
                        - location
                        - locationName
                        - asn
                        - asnName
                        - asnLocation
                        - asnOrgName
                        type: object
                    required:
                    - ip
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                - error
                type: object
          description: Not found
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get IP address
      tags:
      - Radar Entities
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/locations:
    get:
      description: Get a list of locations.
      operationId: radar-get-entities-locations
      parameters:
      - description: Limit the number of objects in the response.
        in: query
        name: limit
        schema:
          description: Limit the number of objects in the response.
          example: 5
          type: integer
      - description: Number of objects to skip before grabbing results.
        in: query
        name: offset
        schema:
          description: Number of objects to skip before grabbing results.
          type: integer
      - description: Comma separated list of locations.
        in: query
        name: location
        schema:
          description: Comma separated list of locations.
          example: US,CA
          type: string
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      locations:
                        items:
                          properties:
                            alpha2:
                              example: AF
                              type: string
                            latitude:
                              example: 33.939116
                              type: string
                            longitude:
                              example: 67.709953
                              type: string
                            name:
                              example: Afghanistan
                              type: string
                          required:
                          - name
                          - latitude
                          - longitude
                          - alpha2
                          type: object
                        type: array
                    required:
                    - locations
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                - result
                - success
                - errors
                type: object
          description: Bad Request
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get locations
      tags:
      - Radar Entities
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/entities/locations/{location}:
    get:
      description: Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).
      operationId: radar-get-entities-location-by-alpha2
      parameters:
      - description: Alpha-2 country code.
        in: path
        name: location
        required: true
        schema:
          description: Alpha-2 country code.
          example: US
          type: string
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      location:
                        properties:
                          alpha2:
                            example: AF
                            type: string
                          confidenceLevel:
                            example: 5
                            type: integer
                          latitude:
                            example: 33.939116
                            type: string
                          longitude:
                            example: 67.709953
                            type: string
                          name:
                            example: Afghanistan
                            type: string
                          region:
                            example: Middle East
                            type: string
                          subregion:
                            example: Southern Asia
                            type: string
                        required:
                        - name
                        - region
                        - subregion
                        - latitude
                        - longitude
                        - alpha2
                        - confidenceLevel
                        type: object
                    required:
                    - location
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    example: Not Found
                    type: string
                required:
                - error
                type: object
          description: Not found
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get location
      tags:
      - Radar Entities
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey