Secciones de la documentación

Documentación de la API

Integre 255 calculadoras de RF y electrónica y 13 herramientas de simulación en sus scripts, cuadernos y aplicaciones mediante REST. Un endpoint ejecuta cualquier calculadora; los simuladores se ejecutan como trabajos que usted envía y consulta. Cada resultado indica cómo se calculó.

URL base https://rftools.io/api/py/v1. Envíe su clave en la cabecera X-API-Key. Una clave gratuita cubre 5 llamadas al mes; obténgala en su panel.

La primera solicitud

Envíe por POST el slug de una calculadora y sus entradas a /calculate. La respuesta incluye cada salida por su nombre, las advertencias y un objeto de procedencia que indica la fórmula, la versión del motor y si las entradas estaban dentro del rango para el que está indicada la calculadora. El código junto a este texto es la llamada, en cuatro lenguajes, y la respuesta que la API devuelve.

Endpoints

Todos los endpoints públicos
Endpoint	Qué hace	Se cuenta
POST /api/py/v1/calculate	Ejecutar una calculadora con sus entradas.	Una llamada
POST /api/py/v1/calculate/batch	Ejecutar hasta 50 cálculos en una sola solicitud.	Una llamada por elemento calculado
POST /api/py/v1/calculate/solve	Hallar el valor de entrada que lleva una salida a un objetivo, con el resultado directo en ese punto.	Una llamada
GET /api/py/v1/usage	La cuota del mes, lo usado y lo que queda, por clave; ?days=N añade las llamadas de cada uno de los últimos N días.	Nunca
GET /api/py/v1/jobs/types	Cada tipo de trabajo de simulación, sus planes, su tiempo máximo, sus límites y sus cargas.	Nunca
GET /api/py/v1/jobs/types/{job_type}	El contrato de parámetros de un tipo de trabajo, como JSON Schema.	Nunca
POST /api/py/v1/jobs/estimate	Lo que costaría un trabajo y cuánto tardaría, sin enviarlo.	Nunca
POST /api/py/v1/upload	Un formulario prefirmado para el archivo de entrada de un trabajo.	Nunca
POST /api/py/v1/jobs	Enviar un trabajo de simulación.	Una llamada, con clave
GET /api/py/v1/jobs/{job_id}	El estado y el progreso de un trabajo y, una vez terminado, el enlace a su resultado.	Nunca
GET /api/py/v1/jobs	Los trabajos recientes del cliente, de todas las claves de la cuenta.	Nunca
POST /api/py/v1/apikeys	Crear una clave para la cuenta con sesión iniciada.	Nunca
POST /api/py/v1/oauth/device/code	Iniciar la autorización de dispositivo: un código que el usuario aprueba.	Nunca
POST /api/py/v1/oauth/device/token	Recoger la clave una vez que el usuario aprobó el código.	Nunca
GET /api/py/health	Estado del servicio.	Nunca

Tipos de trabajo de simulación

13 simuladores se ejecutan como trabajos asíncronos: enviar, consultar, leer el resultado. Cada tipo de trabajo publica su contrato de parámetros; consulte Trabajos de simulación.

Tipos de trabajo de simulación
jobType	Simulador
antenna_sim	Simulador de antena de cable (NEC-2)
emi_radiated	Estimador de emisiones radiadas EMI
eye_diagram	Diagrama ocular a partir de parámetros S
fdtd_sparam	Simulador de línea de transmisión FDTD
filter_monte_carlo	Análisis Monte Carlo del filtro RF
impedance_match	Sintetizador de adaptación de impedancia de banda ancha
magnetics_optimizer	Optimizador de diseño de magnetismo y transformadores
pdn_impedance	Analizador de impedancia PDN y optimizador de condensadores de desacoplamiento
radar_detection	Rendimiento de detección de radar Monte Carlo
rf_cascade	Analizador de presupuesto RF Cascade
sat_link_budget	Presupuesto de enlaces satelitales y terrestres
smps_control_loop	Analizador de estabilidad del bucle de control SMPS
sparam_pipeline	Canalización de análisis de parámetros S

Siguientes pasos

Inicio rápidoUna clave y una primera llamada en un minuto.AutenticaciónLas claves, el enlace de clave y la autorización de dispositivo.CalcularLa solicitud, la respuesta y sus rechazos.Slugs y entradasLas entradas, las salidas y un ejemplo de cada calculadora.Biblioteca de Pythonpip install rftools-io: llamadas tipadas y una CLI.Servidor MCPLas mismas calculadoras y simulaciones para agentes de IA.

Referencia legible por máquina

¿Listo para integrar?

Obtenga su clave y haga una solicitud en menos de un minuto. 10.000 llamadas al mes con el plan API, 120 solicitudes por minuto con una clave, las 255 calculadoras.

Obtener acceso a la API, $19/mes Gestionar claves Obtener una clave de API gratuita

O bien obtenga una clave gratuita (5 llamadas al mes) en su panel; no se necesita tarjeta de crédito.

La primera solicitud

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