APIVerve
APIVerveDocumentation
Ctrl+K
apiverve

HTML Entities Encoder/DecoderHTML Entities Encoder/Decoder API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 247ms|p50: 234ms|p75: 256ms|p90: 283ms|p99: 336ms

Overview

To use HTML Entities Encoder/Decoder, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

URL
https://api.apiverve.com/v1/htmlentities

Example

How to call the HTML Entities Encoder/Decoder API in different programming languages.

cURL Request
curl -X POST \
  "https://api.apiverve.com/v1/htmlentities" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "html": "<div class=\"test\">Hello & World</div>",
  "action": "encode"
}'
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/htmlentities', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "html": "<div class=\"test\">Hello & World</div>",
    "action": "encode"
})
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

payload = {
    "html": "<div class=\"test\">Hello & World</div>",
    "action": "encode"
}

response = requests.post('https://api.apiverve.com/v1/htmlentities', headers=headers, json=payload)

data = response.json()
print(data)
Go (net/http)
package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "html": "<div class="test">Hello & World</div>",
        "action": "encode"
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/htmlentities", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "action": "encode",
    "original": "<div class=\"test\">Hello & World</div>",
    "encoded": "&lt;div class=&quot;test&quot;&gt;Hello &amp; World&lt;&#x2F;div&gt;",
    "entities_replaced": [
      "<",
      "\"",
      ">",
      "&",
      "/"
    ],
    "count": 8
  }
}

Authentication

The HTML Entities Encoder/Decoder API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the HTML Entities Encoder/Decoder API directly in your browser with live requests and responses.

Try HTML Entities Encoder/Decoder APIView details and test in the API marketplace

Parameters

The HTML Entities Encoder/Decoder API supports multiple query options. Use one of the following:

Option 1: Encode HTML Entities

ParameterTypeRequiredDescriptionDefaultExample
htmlstringrequired
The HTML content to encode
-<div>Hello & Welcome</div>
actionstringoptional
The action to perform
Supported values: encodedecode
encodeencode

Option 2: Decode HTML Entities

ParameterTypeRequiredDescriptionDefaultExample
htmlstringrequired
The HTML entities to decode
-&lt;div&gt;Hello &amp; Welcome&lt;/div&gt;
actionstringoptional
The action to perform
Supported values: encodedecode
encodedecode

Response

The HTML Entities Encoder/Decoder API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <action>encode</action>
    <original>&lt;div class=&quot;test&quot;&gt;Hello &amp; World&lt;/div&gt;</original>
    <encoded>&amp;lt;div class=&amp;quot;test&amp;quot;&amp;gt;Hello &amp;amp; World&amp;lt;&amp;#x2F;div&amp;gt;</encoded>
    <entities_replaced>
      <item>&lt;</item>
      <item>&quot;</item>
      <item>&gt;</item>
      <item>&amp;</item>
      <item>/</item>
    </entities_replaced>
    <count>8</count>
  </data>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  action: encode
  original: <div class="test">Hello & World</div>
  encoded: '&lt;div class=&quot;test&quot;&gt;Hello &amp; World&lt;&#x2F;div&gt;'
  entities_replaced:
    - <
    - '"'
    - '>'
    - '&'
    - /
  count: 8
CSV Response
200 OK
keyvalue
actionencode
original<div class=test>Hello & World</div>
encoded&lt;div class=&quot;test&quot;&gt;Hello &amp; World&lt;&#x2F;div&gt;
entities_replaced[<,\,>,&,/]
count8

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample ValueDescription
actionstring"encode"
The action performed on the HTML content
originalstring"<div class="test">Hello & World</div>"
The original HTML entities before decoding
encodedstring"&lt;div class=&quot;test&quot;&gt;Hello &amp; World&lt;&#x2F;div&gt;"
The HTML content with entities decoded
entities_replacedarray["<", ...]
Array of entity patterns that were replaced
countnumber8
Total number of entity replacements made

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access HTML Entities Encoder/Decoder through GraphQL to combine it with other API calls in a single request. Query only the html entities encoder/decoder data you need with precise field selection, and orchestrate complex data fetching workflows.

Test HTML Entities Encoder/Decoder in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  htmlentities(
    input: {
      html: "<div class="test">Hello & World</div>"
      action: "encode"
    }
  ) {
    action
    original
    encoded
    entities_replaced
    count
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The HTML Entities Encoder/Decoder API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

HTML Entities Encoder/Decoder requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The HTML Entities Encoder/Decoder API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for HTML Entities Encoder/Decoder

Official HTML Entities Encoder/Decoder packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

NPMPyPINuGetSwaggerJitPackJitPack

No-Code Integrations

HTML Entities Encoder/Decoder works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier
Zapier
Make
Make
Pipedream
Pipedream
n8n
n8n
Power Automate
Power Automate

Frequently Asked Questions

How do I get an API key for HTML Entities Encoder/Decoder?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for HTML Entities Encoder/Decoder and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does HTML Entities Encoder/Decoder cost?

Each successful HTML Entities Encoder/Decoder API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful html entities encoder/decoder lookups.

Can I use HTML Entities Encoder/Decoder in production?

The free plan is for testing and development only. For production use of HTML Entities Encoder/Decoder, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use HTML Entities Encoder/Decoder from a browser?
Yes! The HTML Entities Encoder/Decoder API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my HTML Entities Encoder/Decoder credit limit?

When you reach your monthly credit limit, HTML Entities Encoder/Decoder API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Browse All APIs

Explore our complete catalog of APIs

Authentication Guide

Learn about API keys and security

Rate Limits

Understand usage limits and best practices

Was this page helpful?