Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
voltage
number
required

Voltage at Fault Point (V)

Required range: x >= 0
transformerKva
number
required

Transformer Rating (kVA)

Required range: x >= 0
transformerImpedancePercent
number
required

Transformer Impedance (%Z)

Required range: 0.1 <= x <= 20
cableLength
number
required

Cable Length to Fault Point (m)

Required range: x >= 0
conductorSize
number
required

Conductor Cross-Sectional Area (mm²)

Required range: x >= 0.1
circuitType
enum<string>

Fault Type

Available options:
three,
single
conductorMaterial
enum<string>

Conductor Material

Available options:
copper,
aluminum

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.