Skip to content
Documentation sections

API Documentation

Integrate 257 RF and electronics calculators and 14 simulation tools into your scripts, notebooks and applications over REST. One endpoint runs any calculator; the simulators run as jobs you submit and poll. Every result says how it was computed.

Base URL https://rftools.io/api/py/v1. Send your key in the X-API-Key header. A free key covers 5 calls a month; get one on your dashboard.

The first request

POST a calculator's slug and its inputs to /calculate. The answer carries every output by key, the warnings, and a provenance object naming the formula, the engine version and whether the inputs were inside the range the calculator is stated for. The code beside this text is the call, in four languages, and the response the API returns for it.

Endpoints

Every public endpoint
EndpointWhat it doesCounted
POST /api/py/v1/calculateRun one calculator on its inputs.One call
POST /api/py/v1/calculate/batchRun up to 50 calculations in one request.One call per item computed
POST /api/py/v1/calculate/solveFind the input value that brings an output to a target, with the forward result at it.One call
GET /api/py/v1/usageThe month's allowance, what is used and left, per key; ?days=N adds the calls of each of the last N days.Never
GET /api/py/v1/jobs/typesEvery simulation job type, its tiers, time ceiling, limits and uploads.Never
GET /api/py/v1/jobs/types/{job_type}One job type's parameter contract, as JSON Schema.Never
POST /api/py/v1/jobs/estimateWhat a job would cost and how long it would run, without submitting it.Never
POST /api/py/v1/uploadA presigned form for a job's input file.Never
POST /api/py/v1/jobsSubmit a simulation job.One call, with a key
GET /api/py/v1/jobs/{job_id}A job's status, progress and, once complete, its result link.Never
GET /api/py/v1/jobsThe caller's recent jobs, from every key of the account.Never
POST /api/py/v1/apikeysCreate a key for the signed-in account.Never
POST /api/py/v1/oauth/device/codeStart the device grant: a code for the user to approve.Never
POST /api/py/v1/oauth/device/tokenCollect the key once the user approved the code.Never
GET /api/py/healthService status.Never

Simulation job types

14 simulators run as asynchronous jobs: submit, poll, read the result. Each job type publishes its parameter contract; see Simulation jobs.

Where to go next

Machine-readable reference

Ready to integrate?

Get your key and make a request in under a minute. 10,000 calls a month on the API plan, 120 requests a minute with a key, all 257 calculators.

Or get a free key (5 calls a month) from your dashboard; no credit card required.