Home API Documentation Encoder API

About the Encoder API

API Version: 1.9

The Encoder allows you to encode and decode using URL encoding, Base64, and Base64 URL.

This is the API for the Encoder.

Endpoints

https://networkcalc.com/api/encoder/{value}

Encodes or decodes a value.

Parameters

{value}

(Required) The value to encode or decode

Example: https://networkcalc.com/api/encoder/Test value to encode.

encoding

(Required) The encoding scheme to use.

Values: url,base64,base64url

Example: https://networkcalc.com/api/encoder/base64

decode

(Optional) Set this to true to decode instead of encode.

Values: true,1

Example: https://networkcalc.com/api/encoder/VGhpcyBpcyBhIHRlc3Qh?encoding=base64&decode=true

Response Format

EncoderResponse chevron_right

Response Codes

200
OK - Success.
400
NOT_ENCODED - The {value} could not be encoded. Check all parameters and try again.
400
NOT_DECODED - The {value} could not be decoded. Check all parameters and try again.

Examples

Example 1
Run this in the API
cURL Example
curl -X GET https://networkcalc.com/api/encoder/This%20is%20a%20test!?encoding=base64
content_copy
PowerShell Example
Invoke-RestMethod https://networkcalc.com/api/encoder/This%20is%20a%20test!?encoding=base64 -Method GET | ConvertTo-Json
content_copy
Python Example
import requests
requests.get("https://networkcalc.com/api/encoder/This%20is%20a%20test!?encoding=base64").json()
content_copy
Response
{
  "status": "OK",
  "original": "This%20is%20a%20test!",
  "encoded": "VGhpcyBpcyBhIHRlc3Qh"
}
content_copy

Response Formats

{
  "status": "[string] The status of the request.",
  "original": "[string] The original value given in the request. If passed as a URL-encoded string, this field will contain the original value without URL encoding.",
  "encoded|decoded": "[string] The result of encoding or decoding the original value."
}
content_copy