Pipe Friction Loss Calculator API

curl --request POST \
  --url https://api.iotools.cloud/v1/tool/pipe-friction-loss-calculator \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "darcy",
  "flowRate": "100",
  "flowUnit": "lpm",
  "diameter": "50",
  "diameterUnit": "mm",
  "length": "100",
  "lengthUnit": "m",
  "material": "steel",
  "fluid": "water20",
  "minorK": "0"
}
'

{
  "outputs": {
    "status": "<string>",
    "result": [
      {
        "property": "<string>",
        "value": "<string>"
      }
    ]
  },
  "tool": "<string>",
  "tool_version": "<string>",
  "credits_used": 123,
  "credits_remaining": 123,
  "request_id": "<string>"
}

{
  "type": "https://docs.iotools.cloud/errors/validation_error",
  "title": "Invalid request",
  "status": 400,
  "code": "validation_error",
  "detail": "One or more inputs are invalid — see `fields`.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "fields": {
    "inputString": "Required"
  }
}

{
  "type": "https://docs.iotools.cloud/errors/invalid_api_key",
  "title": "Invalid API key",
  "status": 401,
  "code": "invalid_api_key",
  "detail": "Provide 'Authorization: Bearer <key>'.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://docs.iotools.cloud/errors/insufficient_credits",
  "title": "Insufficient credits",
  "status": 402,
  "code": "insufficient_credits",
  "detail": "This call costs 1 credit and 0 remain in this month's allowance.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0,
  "credits_remaining": 0
}

{
  "type": "https://docs.iotools.cloud/errors/tool_not_allowed",
  "title": "Tool not available over the API",
  "status": 403,
  "code": "tool_not_allowed",
  "detail": "\"Background Remover\" is available on iotools.cloud but has no API endpoint.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://docs.iotools.cloud/errors/tool_not_found",
  "title": "Tool not found",
  "status": 404,
  "code": "tool_not_found",
  "detail": "No tool with that slug. See GET /v1/tools/list.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://docs.iotools.cloud/errors/payload_too_large",
  "title": "Payload too large",
  "status": 413,
  "code": "payload_too_large",
  "detail": "Request body exceeds this tool's size limit.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://docs.iotools.cloud/errors/unprocessable_input",
  "title": "Input cannot be processed",
  "status": 422,
  "code": "unprocessable_input",
  "detail": "This video has no captions or subtitles, so there is no transcript to extract.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0
}

{
  "type": "https://docs.iotools.cloud/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Too many requests. Retry in 30s.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "retry_after": 30
}

{
  "type": "https://docs.iotools.cloud/errors/processing_error",
  "title": "Tool failed to run",
  "status": 500,
  "code": "processing_error",
  "detail": "The tool failed to run. Please try again.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0
}

{
  "type": "https://docs.iotools.cloud/errors/tool_disabled",
  "title": "Tool temporarily disabled",
  "status": 503,
  "code": "tool_disabled",
  "detail": "This tool is temporarily unavailable. Try again shortly.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

POST

tool

pipe-friction-loss-calculator

curl --request POST \
  --url https://api.iotools.cloud/v1/tool/pipe-friction-loss-calculator \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "darcy",
  "flowRate": "100",
  "flowUnit": "lpm",
  "diameter": "50",
  "diameterUnit": "mm",
  "length": "100",
  "lengthUnit": "m",
  "material": "steel",
  "fluid": "water20",
  "minorK": "0"
}
'

{
  "outputs": {
    "status": "<string>",
    "result": [
      {
        "property": "<string>",
        "value": "<string>"
      }
    ]
  },
  "tool": "<string>",
  "tool_version": "<string>",
  "credits_used": 123,
  "credits_remaining": 123,
  "request_id": "<string>"
}

{
  "type": "https://docs.iotools.cloud/errors/validation_error",
  "title": "Invalid request",
  "status": 400,
  "code": "validation_error",
  "detail": "One or more inputs are invalid — see `fields`.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "fields": {
    "inputString": "Required"
  }
}

{
  "type": "https://docs.iotools.cloud/errors/invalid_api_key",
  "title": "Invalid API key",
  "status": 401,
  "code": "invalid_api_key",
  "detail": "Provide 'Authorization: Bearer <key>'.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://docs.iotools.cloud/errors/insufficient_credits",
  "title": "Insufficient credits",
  "status": 402,
  "code": "insufficient_credits",
  "detail": "This call costs 1 credit and 0 remain in this month's allowance.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0,
  "credits_remaining": 0
}

{
  "type": "https://docs.iotools.cloud/errors/tool_not_allowed",
  "title": "Tool not available over the API",
  "status": 403,
  "code": "tool_not_allowed",
  "detail": "\"Background Remover\" is available on iotools.cloud but has no API endpoint.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://docs.iotools.cloud/errors/tool_not_found",
  "title": "Tool not found",
  "status": 404,
  "code": "tool_not_found",
  "detail": "No tool with that slug. See GET /v1/tools/list.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://docs.iotools.cloud/errors/payload_too_large",
  "title": "Payload too large",
  "status": 413,
  "code": "payload_too_large",
  "detail": "Request body exceeds this tool's size limit.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

{
  "type": "https://docs.iotools.cloud/errors/unprocessable_input",
  "title": "Input cannot be processed",
  "status": 422,
  "code": "unprocessable_input",
  "detail": "This video has no captions or subtitles, so there is no transcript to extract.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0
}

{
  "type": "https://docs.iotools.cloud/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Too many requests. Retry in 30s.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "retry_after": 30
}

{
  "type": "https://docs.iotools.cloud/errors/processing_error",
  "title": "Tool failed to run",
  "status": 500,
  "code": "processing_error",
  "detail": "The tool failed to run. Please try again.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11",
  "credits_used": 0
}

{
  "type": "https://docs.iotools.cloud/errors/tool_disabled",
  "title": "Tool temporarily disabled",
  "status": 503,
  "code": "tool_disabled",
  "detail": "This tool is temporarily unavailable. Try again shortly.",
  "request_id": "e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

flowRate

number

required

Flow Rate

Required range: x >= 0

diameter

number

required

Inside Diameter

Required range: x >= 0

length

number

required

Pipe Length

Required range: x >= 0

method

enum<string>

Method

Available options:

darcy,

hazen

flowUnit

enum<string>

Flow Unit

Available options:

lpm,

lps,

m3h,

gpm,

cfm

diameterUnit

enum<string>

Diameter Unit

Available options:

mm,

in,

m

lengthUnit

enum<string>

Length Unit

Available options:

m,

ft

material

enum<string>

Pipe Material

Available options:

pvc,

copper,

steel,

galvanized,

cast-iron,

concrete,

custom

roughness

number

Absolute Roughness (mm)

Required range: x >= 0

cFactor

number

Hazen–Williams C

Required range: x >= 1

minorK

number

Fittings Loss Coefficient (ΣK)

Required range: x >= 0

fluid

enum<string>

Fluid

Available options:

water20,

water60,

seawater20,

ethanol20,

sae30,

custom

density

number

Density (kg/m³)

Required range: x >= 0

viscosity

number

Dynamic Viscosity (cP)

Required range: x >= 0

Response

Tool output

outputs

object

required

Show child attributes

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.

Overview

Catalog

Account

Tools

Pipe Friction Loss Calculator API

Authorizations

Body

Response