Abschnitte der Dokumentation

API-Dokumentation

Binden Sie 255 HF- und Elektronikrechner und 13 Simulationswerkzeuge per REST in Ihre Skripte, Notebooks und Anwendungen ein. Ein Endpunkt führt jeden Rechner aus; die Simulatoren laufen als Jobs, die Sie einreichen und abfragen. Jedes Ergebnis gibt an, wie es berechnet wurde.

Basis-URL https://rftools.io/api/py/v1. Senden Sie Ihren Schlüssel im Header X-API-Key. Ein kostenloser Schlüssel deckt 5 Aufrufe pro Monat ab; holen Sie ihn sich in Ihrem Dashboard.

Die erste Anfrage

Senden Sie den Slug eines Rechners und seine Eingaben per POST an /calculate. Die Antwort enthält jede Ausgabe unter ihrem Namen, die Warnungen und ein Provenienz-Objekt, das die Formel und die Engine-Version nennt und angibt, ob die Eingaben in dem Bereich lagen, für den der Rechner ausgelegt ist. Der Code neben diesem Text ist der Aufruf in vier Sprachen und die Antwort, die die API darauf gibt.

Endpunkte

Alle öffentlichen Endpunkte
Endpunkt	Was er tut	Gezählt
POST /api/py/v1/calculate	Einen Rechner mit seinen Eingaben ausführen.	Ein Aufruf
POST /api/py/v1/calculate/batch	Bis zu 50 Berechnungen in einer Anfrage ausführen.	Ein Aufruf pro berechnetem Eintrag
POST /api/py/v1/calculate/solve	Den Eingabewert finden, der eine Ausgabe auf einen Zielwert bringt, mit dem Vorwärtsergebnis an dieser Stelle.	Ein Aufruf
GET /api/py/v1/usage	Das Kontingent des Monats, was verbraucht und was übrig ist, pro Schlüssel; ?days=N ergänzt die Aufrufe jedes der letzten N Tage.	Nie
GET /api/py/v1/jobs/types	Jeder Simulationsjobtyp, seine Tarife, seine Zeitobergrenze, seine Limits und Uploads.	Nie
GET /api/py/v1/jobs/types/{job_type}	Der Parametervertrag eines Jobtyps, als JSON Schema.	Nie
POST /api/py/v1/jobs/estimate	Was ein Job kosten und wie lange er laufen würde, ohne ihn einzureichen.	Nie
POST /api/py/v1/upload	Ein vorsigniertes Formular für die Eingabedatei eines Jobs.	Nie
POST /api/py/v1/jobs	Einen Simulationsjob einreichen.	Ein Aufruf, mit Schlüssel
GET /api/py/v1/jobs/{job_id}	Status und Fortschritt eines Jobs und, sobald er fertig ist, der Link zu seinem Ergebnis.	Nie
GET /api/py/v1/jobs	Die letzten Jobs des Aufrufers, aus allen Schlüsseln des Kontos.	Nie
POST /api/py/v1/apikeys	Einen Schlüssel für das angemeldete Konto erstellen.	Nie
POST /api/py/v1/oauth/device/code	Die Gerätefreigabe starten: ein Code, den der Nutzer freigibt.	Nie
POST /api/py/v1/oauth/device/token	Den Schlüssel abholen, sobald der Nutzer den Code freigegeben hat.	Nie
GET /api/py/health	Status des Dienstes.	Nie

Simulationsjobtypen

13 Simulatoren laufen als asynchrone Jobs: einreichen, abfragen, Ergebnis lesen. Jeder Jobtyp veröffentlicht seinen Parametervertrag; siehe Simulationsjobs.

Simulationsjobtypen
jobType	Simulator
antenna_sim	Drahtantennen-Simulator (NEC-2)
emi_radiated	Schätzer für EMI-Strahlemissionen
eye_diagram	Augendiagramm aus S-Parametern
fdtd_sparam	FDTD-Übertragungsleitungssimulator
filter_monte_carlo	HF-Filter Monte-Carlo-Analyse
impedance_match	Breitband-Impedanzanpassungssynthesizer
magnetics_optimizer	Designoptimierer für Magnetik und Transformatoren
pdn_impedance	PDN-Impedanzanalysator und Entkopplungskondensator-Optimierer
radar_detection	Leistung der Radarerkennung Monte Carlo
rf_cascade	RF Cascade Budgetanalysator
sat_link_budget	Budget für Satelliten- und terrestrische Verbindungen
smps_control_loop	SMPS-Regelkreisstabilitätsanalysator
sparam_pipeline	S-Parameter-Analysepipeline

Wie es weitergeht

SchnellstartEin Schlüssel und ein erster Aufruf in einer Minute.AuthentifizierungSchlüssel, der Schlüssel-Link und die Gerätefreigabe.BerechnenDie Anfrage, die Antwort und ihre Ablehnungen.Slugs und EingabenEingaben, Ausgaben und ein Beispiel für jeden Rechner.Python-Bibliothekpip install rftools-io: typisierte Aufrufe und eine CLI.MCP-ServerDieselben Rechner und Simulationen für KI-Agenten.

Maschinenlesbare Referenz

Bereit für die Integration?

Holen Sie sich Ihren Schlüssel und senden Sie in weniger als einer Minute eine Anfrage. 10.000 Aufrufe pro Monat im API-Tarif, 120 Anfragen pro Minute mit Schlüssel, alle 255 Rechner.

API-Zugang holen, $19/Monat Schlüssel verwalten Kostenlosen API-Schlüssel holen

Oder holen Sie sich einen kostenlosen Schlüssel (5 Aufrufe pro Monat) in Ihrem Dashboard; keine Kreditkarte nötig.

Die erste Anfrage

curl -X POST https://rftools.io/api/py/v1/calculate \
  -H "X-API-Key: $RFTOOLS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "vswr-return-loss",
    "inputs": {
      "vswr": 2
    }
  }'

import rftools

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

result = client.calculate("vswr-return-loss", {"vswr": 2})
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": "vswr-return-loss",
    "inputs": {
      "vswr": 2
    }
  }),
});
console.log(response.status, await response.json());

package main

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

func main() {
	body := []byte(`{
	  "slug": "vswr-return-loss",
	  "inputs": {
	    "vswr": 2
	  }
	}`)
	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))
}

200application/json

{
  "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
  }
}