Sections de la documentation

Calcul par lots

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

Jusqu'à 50 calculs en une requête, avec n'importe quelle combinaison de calculateurs : un balayage de paramètres ou les valeurs d'une même conception. Chaque élément est calculé exactement comme /calculate le calcule.

Le point de terminaison par lots fait partie de l'offre API. Chaque élément calculé compte pour un appel ; un élément refusé avant d'être calculé ne coûte rien.

Corps de la requête

BatchRequest
Champ	Description
calculationsobligatoirearray	De 1 à 50 éléments, chacun {slug, inputs} comme /calculate les accepte. Au-delà, la requête est refusée avec 400 et la limite.

Réponse

BatchResponse
Champ	Description
resultsarray	Un élément par calcul, dans l'ordre.
results[].slugstring	Le calculateur de l'élément.
results[].values, warnings, errors, provenanceas /calculate	Un élément calculé : exactement ce que /calculate renvoie pour lui.
results[].error, errorKindstring	Un élément non calculé : la raison (un slug inconnu, une entrée qui n'est pas un nombre fini). Il n'a pas été décompté.

Les résultats suivent l'ordre de la requête. Vérifiez chaque élément : un élément calculé a values et provenance ; un élément qui ne l'a pas été a error et errorKind. L'échec d'un élément ne fait jamais échouer les autres.

Refus

400 : aucun calcul (At least one calculation is required), ou plus de 50, avec la limite.
401 : aucune clé, ou une clé non valide.
402 : le quota ne couvre pas les éléments à calculer ; rien n'a été décompté.
403 : l'offre du compte n'a pas accès aux lots ; le corps nomme l'offre qui y donne accès.

curl -X POST https://rftools.io/api/py/v1/calculate/batch \
  -H "X-API-Key: $RFTOOLS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "calculations": [
      {
        "slug": "vswr-return-loss",
        "inputs": {
          "vswr": 1.5
        }
      },
      {
        "slug": "vswr-return-loss",
        "inputs": {
          "vswr": 2
        }
      },
      {
        "slug": "free-space-path-loss",
        "inputs": {
          "frequency": 2400,
          "distance": 0.05
        }
      },
      {
        "slug": "vswr-calculator",
        "inputs": {
          "vswr": 2
        }
      }
    ]
  }'

import rftools

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

results = client.batch([
    ("vswr-return-loss", {"vswr": 1.5}),
    ("vswr-return-loss", {"vswr": 2}),
    ("free-space-path-loss", {"frequency": 2400, "distance": 0.05}),
    ("vswr-calculator", {"vswr": 2}),
])
for r in results:
    print(r.values if r.ok else r.error)

const response = await fetch("https://rftools.io/api/py/v1/calculate/batch", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.RFTOOLS_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "calculations": [
      {
        "slug": "vswr-return-loss",
        "inputs": {
          "vswr": 1.5
        }
      },
      {
        "slug": "vswr-return-loss",
        "inputs": {
          "vswr": 2
        }
      },
      {
        "slug": "free-space-path-loss",
        "inputs": {
          "frequency": 2400,
          "distance": 0.05
        }
      },
      {
        "slug": "vswr-calculator",
        "inputs": {
          "vswr": 2
        }
      }
    ]
  }),
});
console.log(response.status, await response.json());

package main

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

func main() {
	body := []byte(`{
	  "calculations": [
	    {
	      "slug": "vswr-return-loss",
	      "inputs": {
	        "vswr": 1.5
	      }
	    },
	    {
	      "slug": "vswr-return-loss",
	      "inputs": {
	        "vswr": 2
	      }
	    },
	    {
	      "slug": "free-space-path-loss",
	      "inputs": {
	        "frequency": 2400,
	        "distance": 0.05
	      }
	    },
	    {
	      "slug": "vswr-calculator",
	      "inputs": {
	        "vswr": 2
	      }
	    }
	  ]
	}`)
	req, err := http.NewRequest("POST", "https://rftools.io/api/py/v1/calculate/batch", 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

{
  "results": [
    {
      "slug": "vswr-return-loss",
      "values": {
        "gamma": 0.2,
        "returnLoss": 13.979400086720375,
        "mismatchLoss": 0.17728766960431602,
        "reflectedPct": 4.000000000000001,
        "transmittedPct": 96
      },
      "warnings": [],
      "errors": [],
      "provenance": {
        "method": "calculator:vswr-return-loss",
        "version": "api@3f2c1a9b04de",
        "formulaRef": "Pozar, \"Microwave Engineering\" 4th ed., Chapter 2",
        "assumptions": [],
        "validRange": {
          "status": "inside",
          "bounds": {
            "vswr": {
              "min": 1,
              "max": 100,
              "unit": ":1"
            }
          },
          "outside": [],
          "model": null
        },
        "computedAt": "2026-09-24T14:05:11.002Z",
        "inputs": {
          "vswr": 1.5
        },
        "seed": null,
        "elapsedSeconds": 0.002
      }
    },
    {
      "slug": "vswr-return-loss",
      "values": {
        "gamma": 0.3333333333333333,
        "returnLoss": 9.54242509439325,
        "mismatchLoss": 0.5115252244738131,
        "reflectedPct": 11.11111111111111,
        "transmittedPct": 88.88888888888889
      },
      "warnings": [],
      "errors": [],
      "provenance": {
        "method": "calculator:vswr-return-loss",
        "version": "api@3f2c1a9b04de",
        "formulaRef": "Pozar, \"Microwave Engineering\" 4th ed., Chapter 2",
        "assumptions": [],
        "validRange": {
          "status": "inside",
          "bounds": {
            "vswr": {
              "min": 1,
              "max": 100,
              "unit": ":1"
            }
          },
          "outside": [],
          "model": null
        },
        "computedAt": "2026-09-24T14:05:11.003Z",
        "inputs": {
          "vswr": 2
        },
        "seed": null,
        "elapsedSeconds": 0.003
      }
    },
    {
      "slug": "free-space-path-loss",
      "values": {
        "fspl_dB": 74.03140814283587,
        "fspl_linear": 25301182.210788365
      },
      "warnings": [],
      "errors": [],
      "provenance": {
        "method": "calculator:free-space-path-loss",
        "version": "api@3f2c1a9b04de",
        "formulaRef": "ITU-R P.525-4, Calculation of free-space attenuation",
        "assumptions": [],
        "validRange": {
          "status": "inside",
          "bounds": {
            "frequency": {
              "min": 0.1,
              "max": null,
              "unit": "MHz"
            },
            "distance": {
              "min": 0.001,
              "max": null,
              "unit": "km"
            }
          },
          "outside": [],
          "model": null
        },
        "computedAt": "2026-09-24T14:05:11.004Z",
        "inputs": {
          "frequency": 2400,
          "distance": 0.05
        },
        "seed": null,
        "elapsedSeconds": 0.004
      }
    },
    {
      "slug": "vswr-calculator",
      "error": "Calculator 'vswr-calculator' not found",
      "errorKind": "invalid_request"
    }
  ]
}

Le dernier élément ne nomme aucun calculateur : refusé seul, et non décompté.

{
  "detail": "The batch endpoint is part of the API plan. This key's account is on the Free plan.",
  "errorKind": "not_available",
  "tier": "free",
  "requiredTier": "api",
  "upgradeUrl": "https://rftools.io/pricing/"
}

L'offre du compte n'a pas accès aux lots.

{
  "detail": "Batch limit is 50 calculations per request",
  "errorKind": "invalid_request",
  "limit": 50
}

Plus de 50 calculs.