CloudRF Account API

Account-level resources such as metrics.

GitHub OpenAPI

Operations 1

GET /my-metrics Get metrics for API usage #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cloudrf:cloudrf-account-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudrf-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: CloudRF Account API
  description: The CloudRF API enables users to model and test radio propagation for any radio, anywhere. Authenticate by passing your API key in the request header as `key`. Set up a CloudRF.com account to generate this key. All data is transferred as JSON. For detailed documentation, visit docs.cloudrf.com.
  termsOfService: https://cloudrf.com/terms-and-conditions/
  contact:
    email: support@cloudrf.com
  version: '3.36'
servers:
- url: https://api.cloudrf.com
  description: Production environment
- url: https://dev.cloudrf.com
  description: Development environment
security:
- ApiKeyAuth: []
tags:
- name: Account
  description: This set of endpoints allow the user to manage their account.
paths:
  /my-metrics:
    get:
      operationId: myMetrics
      tags:
      - Account
      summary: Get metrics for API usage
      description: 'Get a detailed breakdown of metrics and statistics for your account API usage over your purchase period.

        This includes a breakdown of total API requests and their types, along with the different types of requests which were made on each day.'
      responses:
        '200':
          description: Success - JSON object returned containing metrics and statistics.
          content:
            application/json:
              schema:
                type: object
                description: An object containing the results of the /bsa call.
                properties:
                  from:
                    type: string
                    format: date-time
                    description: The period over which the metrics have been calculated.
                    example: '2022-07-10 13:06:36.851'
                  count_total:
                    type: number
                    format: integer
                    description: The total number of requests over the period.
                    example: 2279
                  time_series:
                    type: object
                    description: Array of objects describing the total calculation of each type for each day in ISO8601 format.
                    properties:
                      YYYY-MM-DD:
                        type: object
                        properties:
                          area:
                            type: number
                            format: integer
                            description: The number of area calculations on the day.
                          path:
                            type: number
                            format: integer
                            description: The number of path calculations on the day.
                          points:
                            type: number
                            format: integer
                            description: The number of points calculations on the day.
                          mesh:
                            type: number
                            format: integer
                            description: The number of mesh calculations on the day.
                          interference:
                            type: number
                            format: integer
                            description: The number of interference calculations on the day.
                          network:
                            type: number
                            format: integer
                            description: The number of network calculations on the day.
                          best_site_analysis:
                            type: number
                            format: integer
                            description: The number of best site analysis calculations on the day.
                    example:
                    - '2022-07-11':
                      - area: 1
                        path: 0
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 0
                    - '2022-07-12':
                      - area: 102
                        path: 6
                        points: 15
                        mesh: 6
                        interference: 6
                        network: 6
                        best_site_analysis: 0
                    - '2022-07-13':
                      - area: 45
                        path: 1
                        points: 2
                        mesh: 1
                        interference: 1
                        network: 1
                        best_site_analysis: 0
                    - '2022-07-14':
                      - area: 31
                        path: 3
                        points: 6
                        mesh: 3
                        interference: 3
                        network: 3
                        best_site_analysis: 0
                    - '2022-07-15':
                      - area: 45
                        path: 4
                        points: 73
                        mesh: 4
                        interference: 4
                        network: 4
                        best_site_analysis: 0
                    - '2022-07-18':
                      - area: 62
                        path: 25
                        points: 23
                        mesh: 6
                        interference: 6
                        network: 13
                        best_site_analysis: 0
                    - '2022-07-20':
                      - area: 217
                        path: 76
                        points: 40
                        mesh: 20
                        interference: 20
                        network: 20
                        best_site_analysis: 0
                    - '2022-07-21':
                      - area: 30
                        path: 2
                        points: 6
                        mesh: 3
                        interference: 3
                        network: 3
                        best_site_analysis: 0
                    - '2022-07-22':
                      - area: 0
                        path: 22
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 0
                    - '2022-07-25':
                      - area: 102
                        path: 3
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 35
                    - '2022-07-26':
                      - area: 134
                        path: 0
                        points: 375
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 20
                    - '2022-07-27':
                      - area: 11
                        path: 1
                        points: 29
                        mesh: 1
                        interference: 1
                        network: 1
                        best_site_analysis: 4
                    - '2022-07-28':
                      - area: 10
                        path: 53
                        points: 2
                        mesh: 1
                        interference: 1
                        network: 1
                        best_site_analysis: 0
                    - '2022-07-29':
                      - area: 0
                        path: 37
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 0
                    - '2022-08-01':
                      - area: 50
                        path: 1
                        points: 19
                        mesh: 1
                        interference: 3
                        network: 1
                        best_site_analysis: 9
                    - '2022-08-02':
                      - area: 56
                        path: 4
                        points: 8
                        mesh: 1
                        interference: 2
                        network: 4
                        best_site_analysis: 0
                    - '2022-08-03':
                      - area: 109
                        path: 11
                        points: 92
                        mesh: 11
                        interference: 14
                        network: 11
                        best_site_analysis: 0
                    - '2022-08-04':
                      - area: 1
                        path: 0
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 0
                    - '2022-08-05':
                      - area: 15
                        path: 0
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 23
                    - '2022-08-08':
                      - area: 1
                        path: 0
                        points: 0
                        mesh: 0
                        interference: 0
                        network: 0
                        best_site_analysis: 3
                    - '2022-08-09':
                      - area: 30
                        path: 1
                        points: 2
                        mesh: 0
                        interference: 0
                        network: 1
                        best_site_analysis: 0
                  types_total:
                    type: object
                    description: Object containing a total count of each of the different types of calculations over the period.
                    properties:
                      area:
                        type: number
                        format: integer
                        description: Count total of the number of area calculations over the period.
                        example: 1052
                      path:
                        type: number
                        format: integer
                        description: Count total of the number of path calculations over the period.
                        example: 250
                      points:
                        type: number
                        format: integer
                        description: Count total of the number of points calculations over the period.
                        example: 692
                      mesh:
                        type: number
                        format: integer
                        description: Count total of the number of mesh calculations over the period.
                        example: 58
                      interference:
                        type: number
                        format: integer
                        description: Count total of the number of interference calculations over the period.
                        example: 64
                      network:
                        type: number
                        format: integer
                        description: Count total of the number of network calculations over the period.
                        example: 69
                      best_site_analysis:
                        type: number
                        format: integer
                        description: Count total of the number of best site analysis calculations over the period.
                        example: 94
                  remaining_calculations_since_last_purchase:
                    type: number
                    format: integer
                    description: The total number of requests remaining on your account since the last time you made a purchase of either a subscription plan or credits.
                    example: 2983
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: key
      description: An APIKey passed in the request headers.
x-provenance:
  method: harvested
  publisher: CloudRF
  source: https://api.cloudrf.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)