Sections de la documentation

Calculer

POSThttps://rftools.io/api/py/v1/calculate

Exécute n'importe lequel des 255 calculateurs avec les entrées que vous saisiriez sur sa page, dans les unités affichées par la page, et renvoie chaque sortie, les avertissements et la provenance en JSON.

Authentifiez-vous avec l'en-tête X-API-Key. Les clés commencent par rfc_ et se créent sur le tableau de bord. Chaque appel est décompté du quota mensuel du compte : 5 avec Free, 100 avec Pro, 10 000 avec API.

Corps de la requête

CalculateRequest
Champ	Description
slugobligatoirestring	Le calculateur, par le slug de l'adresse de sa page, par ex. rf-link-budget. Tous les slugs figurent sous « Slugs et entrées ».
inputsobligatoireobject of numbers	Les valeurs d'entrée, sous les clés d'entrée du calculateur, dans les unités indiquées par sa référence. Envoyez toutes les entrées : la plupart sont obligatoires, et un appel auquel il en manque une est refusé (400) ; une entrée facultative omise prend la valeur par défaut indiquée dans la référence. Une clé que le calculateur ne lit pas est ignorée avec un avertissement.

Entrées de rf-link-budget

Générées à partir de la définition du calculateur. Une entrée hors de sa plage est tout de même calculée et signalée dans la provenance. Les entrées de chaque calculateur se trouvent sous Slugs et entrées.

Entrées de rf-link-budget
Nom	Unité	Plage	Valeur par défaut	Description
txPowernombre	dBm	−30 … 100	30	Puissance de sortie de l'émetteur
txGainnombre	dBi	−30 … 60	3	Gain de l'antenne TX en dBi
txCableLossnombre	dB	0 … 20	1	Pertes du câble TX + du connecteur (valeur positive)
frequencynombre	MHz	0.1 … 1000000	2400	Fréquence centrale
distancenombre	km	0.001 … 1000000	1	Distance entre TX et RX
rainFadenombre	dB	0 … 50	0	Atténuation de la pluie selon l'UIT-R P.838. Utilisez 0 pour les liaisons terrestres en visibilité directe ; 3 à 20 dB pour les liaisons par satellite supérieures à 10 GHz dans les zones de fortes pluies.
atmosphericLossnombre	dB	0 … 20	0.5	Absorption de gaz (O₂ à 60 GHz : ~15 dB/km ; H₂O à 22 GHz : ~0,2 dB/km). Utilisez 0,5 dB, comme c'est le cas pour les liaisons terrestres inférieures à 6 GHz.
pointingLossnombre	dB	0 … 10	0	Perte de désalignement de l'antenne. Paraboles à rayons : 0,5 à 3 dB. Antennes omnidirectionnelles ou à faisceau large : 0 dB.
extraLossCountnombre	aucune	0 … 4	0	Combien de termes de pertes supplémentaires sont inclus dans le budget, tels que l'inadéquation de la polarisation, la perte corporelle ou le feuillage
extraLoss1nombre	dB	0 … 50	0	Une perte supplémentaire sur le trajet, telle qu'un décalage de polarisation, une perte de corps, de feuillage ou de mur
extraLoss2nombre	dB	0 … 50	0	Une perte supplémentaire sur le trajet, telle qu'un décalage de polarisation, une perte de corps, de feuillage ou de mur
extraLoss3nombre	dB	0 … 50	0	Une perte supplémentaire sur le trajet, telle qu'un décalage de polarisation, une perte de corps, de feuillage ou de mur
extraLoss4nombre	dB	0 … 50	0	Une perte supplémentaire sur le trajet, telle qu'un décalage de polarisation, une perte de corps, de feuillage ou de mur
rxGainnombre	dBi	−30 … 60	3	Gain de l'antenne RX en dBi
rxCableLossnombre	dB	0 … 20	1	Pertes du câble RX et du connecteur
rxSensitivitynombre	dBm	−160 … 0	-90	Niveau de signal recevable minimum
targetMarginnombre	dB	0 … 60	10	La marge de fondu que le lien doit maintenir au-dessus de la sensibilité du récepteur. L'état passe à un niveau supérieur ou égal à celui-ci et passe en dessous de 0 dB.

Réponse

CalculateResponse
Champ	Description
slugstring	Le calculateur, tel que demandé.
valuesobject of numbers	Chaque sortie sous sa clé, dans les unités indiquées par sa référence. null lorsqu'une valeur n'est pas bornée ou pas définie, comme l'affaiblissement de réflexion d'une adaptation parfaite.
warningsstring[]	Les avertissements propres au calculateur, puis ceux de l'API : une entrée non lue, une entrée hors de la plage pour laquelle le calculateur est prévu.
errorsstring[]	Les erreurs du calculateur ; vide en cas de succès.
provenanceobject	Comment les valeurs ont été calculées : méthode, version du moteur, référence de la formule, hypothèses et plage valide. Voir Provenance.

Les sorties de rf-link-budget, dans values :

Sorties de rf-link-budget
Champ	Unité	Description
fspl	dB	Perte de trajectoire spatiale libre
eirp	dBm	EIRP
rxPower	dBm	Puissance reçue
linkMarginprincipale	dB	Marge des liens
maxRangeKm	km	Portée maximale
totalAdditionalLoss	dB	Perte supplémentaire totale
maxRangeAtTarget	km	Fourchette à la marge cible
wavelength	mm	Longueur d'onde
fresnelRadius	m	Rayon de la première zone de Fresnel

Erreurs

Erreurs de POST /calculate
Statut	Exception Python	Quand
400	ValidationError	La requête ne peut pas être traitée telle qu'envoyée : une entrée qui n'est pas un nombre fini, une résolution impossible à poser, un corps de tâche hors de son contrat, ou un lot vide ou au-delà de sa limite. Rien n'est décompté.
401	AuthError	Aucune clé n'a été envoyée (le corps porte keyUrl), ou la clé n'a pas été émise par nous, ou a été révoquée. Ne concerne jamais le quota.
402	QuotaError	Le quota mensuel du compte est épuisé, sur toutes les routes décomptées. Rien n'a été décompté. Retry-After donne les secondes jusqu'à resetAt.
404	NotFound	Aucun slug de calculateur, type de tâche ou tâche de ce nom. Rien n'est décompté.
422	ValidationError	Le corps est illisible : un champ obligatoire manque, ou une valeur est du mauvais type (une entrée envoyée sous forme de texte). Traité avant que la route ne s'exécute.
429	RateLimitError	Trop de requêtes en une minute pour l'identifiant, ou trop de tâches en file d'attente ou en cours à la fois. Retry-After indique quand réessayer.
500	APIError	Le résultat a été calculé mais n'a pas pu être renvoyé, ou une résolution a échoué. Rien n'a été facturé.
503	APIError	La clé ou le compteur de quota n'a pas pu être vérifié, ou une tâche n'a pas pu être mise en file d'attente. Rien n'a été mis en file d'attente ni facturé ; réessayez.

Toutes les vérifications ont lieu avant tout décompte : la clé, le calculateur, puis les entrées. Voir Erreurs pour chaque corps.

Essayer

Envoyez une requête depuis cette page avec votre propre clé. Elle est décomptée comme n'importe quel autre appel.

CalculateurEntrées (JSON)Clé d'API

Une requête nécessite une clé et est décomptée du quota de son compte. Obtenir une clé gratuite.

curl -X POST https://rftools.io/api/py/v1/calculate \
  -H "X-API-Key: $RFTOOLS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "rf-link-budget",
    "inputs": {
      "txPower": 20,
      "txGain": 2,
      "txCableLoss": 1,
      "frequency": 2400,
      "distance": 0.5,
      "rainFade": 0,
      "atmosphericLoss": 0.5,
      "pointingLoss": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "rxGain": 2,
      "rxCableLoss": 1,
      "rxSensitivity": -90,
      "targetMargin": 10
    }
  }'

import rftools

client = rftools.Client()  # reads RFTOOLS_API_KEY, or the key `rftools login` saved

result = client.calculate("rf-link-budget", {
    "txPower": 20,
    "txGain": 2,
    "txCableLoss": 1,
    "frequency": 2400,
    "distance": 0.5,
    "rainFade": 0,
    "atmosphericLoss": 0.5,
    "pointingLoss": 0,
    "extraLossCount": 0,
    "extraLoss1": 0,
    "extraLoss2": 0,
    "extraLoss3": 0,
    "extraLoss4": 0,
    "rxGain": 2,
    "rxCableLoss": 1,
    "rxSensitivity": -90,
    "targetMargin": 10,
})
print(result.values)
print(result.warnings, result.provenance.formula_ref)

const response = await fetch("https://rftools.io/api/py/v1/calculate", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.RFTOOLS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "slug": "rf-link-budget",
    "inputs": {
      "txPower": 20,
      "txGain": 2,
      "txCableLoss": 1,
      "frequency": 2400,
      "distance": 0.5,
      "rainFade": 0,
      "atmosphericLoss": 0.5,
      "pointingLoss": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "rxGain": 2,
      "rxCableLoss": 1,
      "rxSensitivity": -90,
      "targetMargin": 10
    }
  }),
});
console.log(response.status, await response.json());

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "slug": "rf-link-budget",
	  "inputs": {
	    "txPower": 20,
	    "txGain": 2,
	    "txCableLoss": 1,
	    "frequency": 2400,
	    "distance": 0.5,
	    "rainFade": 0,
	    "atmosphericLoss": 0.5,
	    "pointingLoss": 0,
	    "extraLossCount": 0,
	    "extraLoss1": 0,
	    "extraLoss2": 0,
	    "extraLoss3": 0,
	    "extraLoss4": 0,
	    "rxGain": 2,
	    "rxCableLoss": 1,
	    "rxSensitivity": -90,
	    "targetMargin": 10
	  }
	}`)
	req, err := http.NewRequest("POST", "https://rftools.io/api/py/v1/calculate", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("RFTOOLS_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

application/json

{
  "slug": "rf-link-budget",
  "values": {
    "fspl": 94.03140814283587,
    "eirp": 21,
    "rxPower": -72.53140814283587,
    "linkMargin": 17.468591857164128,
    "maxRangeKm": 3.73593745752468,
    "totalAdditionalLoss": 0.5,
    "wavelength": 124.91352416666666,
    "fresnelRadius": 3.951479535671839,
    "maxRangeAtTarget": 1.181407156171655
  },
  "warnings": [],
  "errors": [],
  "provenance": {
    "method": "calculator:rf-link-budget",
    "version": "api@3f2c1a9b04de",
    "formulaRef": "Friis, \"A Note on a Simple Transmission Formula\" (1946)",
    "assumptions": [],
    "validRange": {
      "status": "inside",
      "bounds": {
        "txPower": {
          "min": -30,
          "max": 100,
          "unit": "dBm"
        },
        "txGain": {
          "min": -30,
          "max": 60,
          "unit": "dBi"
        },
        "txCableLoss": {
          "min": 0,
          "max": 20,
          "unit": "dB"
        },
        "frequency": {
          "min": 0.1,
          "max": 1000000,
          "unit": "MHz"
        },
        "distance": {
          "min": 0.001,
          "max": 1000000,
          "unit": "km"
        },
        "rainFade": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "atmosphericLoss": {
          "min": 0,
          "max": 20,
          "unit": "dB"
        },
        "pointingLoss": {
          "min": 0,
          "max": 10,
          "unit": "dB"
        },
        "extraLossCount": {
          "min": 0,
          "max": 4,
          "unit": ""
        },
        "extraLoss1": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss2": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss3": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "extraLoss4": {
          "min": 0,
          "max": 50,
          "unit": "dB"
        },
        "rxGain": {
          "min": -30,
          "max": 60,
          "unit": "dBi"
        },
        "rxCableLoss": {
          "min": 0,
          "max": 20,
          "unit": "dB"
        },
        "rxSensitivity": {
          "min": -160,
          "max": 0,
          "unit": "dBm"
        },
        "targetMargin": {
          "min": 0,
          "max": 60,
          "unit": "dB"
        }
      },
      "outside": [],
      "model": null
    },
    "computedAt": "2026-09-24T14:05:11.003Z",
    "inputs": {
      "txPower": 20,
      "txGain": 2,
      "txCableLoss": 1,
      "frequency": 2400,
      "distance": 0.5,
      "rainFade": 0,
      "atmosphericLoss": 0.5,
      "pointingLoss": 0,
      "extraLossCount": 0,
      "extraLoss1": 0,
      "extraLoss2": 0,
      "extraLoss3": 0,
      "extraLoss4": 0,
      "rxGain": 2,
      "rxCableLoss": 1,
      "rxSensitivity": -90,
      "targetMargin": 10
    },
    "seed": null,
    "elapsedSeconds": 0.003
  }
}

{
  "detail": "Calculator 'rf-link-budgett' not found",
  "errorKind": "invalid_request"
}

Un slug qui n'existe pas. Rien n'a été décompté.

{
  "detail": [
    {
      "type": "float_parsing",
      "loc": [
        "body",
        "inputs",
        "txPower"
      ],
      "msg": "Input should be a valid number, unable to parse string as a number",
      "input": "20 dBm"
    }
  ]
}

Une entrée envoyée sous forme de texte. Traitée avant que la route ne s'exécute ; rien n'a été décompté.

{
  "detail": "This account's 100 API calls for September are used. They reset on 2026-10-01. The API plan includes 10,000 a month.",
  "errorKind": "rate_limited",
  "reason": "allowance",
  "limit": 100,
  "used": 100,
  "upgradeUrl": "https://rftools.io/pricing/",
  "overageUrl": null,
  "resetAt": "2026-10-01T00:00:00+00:00"
}

Le quota du mois est épuisé, avec Retry-After.

{
  "detail": "More than 120 requests in 60 seconds from this address.",
  "errorKind": "rate_limited",
  "limit": 120,
  "windowSeconds": 60,
  "upgradeUrl": "https://rftools.io/pricing/"
}

Trop de requêtes en une minute, avec Retry-After.

Les mêmes entrées sur la page du calculateurCalculateur de budget RF Link, avec ces valeurs dans son adresse