HTML Entities Encoder/Decoder is a tool for encoding and decoding HTML entities. It converts special characters to HTML entities and vice versa to prevent XSS attacks and display special characters properly.
This is a Python API Wrapper for the HTML Entities Encoder/Decoder API
Using pip:
pip install apiverve-htmlentitiesencoder/decoderUsing pip3:
pip3 install apiverve-htmlentitiesencoder/decoderBefore using the htmlentities API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com
Here's a simple example to get you started quickly:
from apiverve_htmlentitiesencoder/decoder.apiClient import HtmlentitiesAPIClient
# Initialize the client with your APIVerve API key
api = HtmlentitiesAPIClient("[YOUR_API_KEY]")
query = {
"html": "<div class=\"test\">Hello & World</div>",
"action": "encode"
}
try:
# Make the API call
result = api.execute(query)
# Print the result
print(result)
except Exception as e:
print(f"Error: {e}")The HTML Entities Encoder/Decoder API documentation is found here: https://docs.apiverve.com/ref/htmlentities. You can find parameters, example responses, and status codes documented here.
# Import the client module
from apiverve_htmlentitiesencoder/decoder.apiClient import HtmlentitiesAPIClient
# Initialize the client with your APIVerve API key
api = HtmlentitiesAPIClient("[YOUR_API_KEY]")Using the API client, you can perform requests to the API.
query = {
"html": "<div class=\"test\">Hello & World</div>",
"action": "encode"
}# Make a request to the API
result = api.execute(query)
# Print the result
print(result){
"status": "ok",
"error": null,
"data": {
"action": "encode",
"original": "<div class=\"test\">Hello & World</div>",
"encoded": "<div class="test">Hello & World</div>",
"entities_replaced": [
"<",
"\"",
">",
"&",
"/"
],
"count": 8
}
}The API client provides comprehensive error handling through the HtmlentitiesAPIClientError exception. Here are some examples:
from apiverve_htmlentitiesencoder/decoder.apiClient import HtmlentitiesAPIClient, HtmlentitiesAPIClientError
api = HtmlentitiesAPIClient("[YOUR_API_KEY]")
query = {
"html": "<div class=\"test\">Hello & World</div>",
"action": "encode"
}
try:
result = api.execute(query)
print("Success!")
print(result)
except HtmlentitiesAPIClientError as e:
print(f"API Error: {e.message}")
if e.status_code:
print(f"Status Code: {e.status_code}")
if e.response:
print(f"Response: {e.response}")from apiverve_htmlentitiesencoder/decoder.apiClient import HtmlentitiesAPIClient, HtmlentitiesAPIClientError
api = HtmlentitiesAPIClient("[YOUR_API_KEY]")
query = {
"html": "<div class=\"test\">Hello & World</div>",
"action": "encode"
}
try:
result = api.execute(query)
# Check for successful response
if result.get('status') == 'success':
print("Request successful!")
print(result.get('data'))
else:
print(f"API returned an error: {result.get('error')}")
except HtmlentitiesAPIClientError as e:
# Handle API client errors
if e.status_code == 401:
print("Unauthorized: Invalid API key")
elif e.status_code == 429:
print("Rate limit exceeded")
elif e.status_code >= 500:
print("Server error - please try again later")
else:
print(f"API error: {e.message}")
except Exception as e:
# Handle unexpected errors
print(f"Unexpected error: {str(e)}")The client supports the context manager protocol for automatic resource cleanup:
from apiverve_htmlentitiesencoder/decoder.apiClient import HtmlentitiesAPIClient, HtmlentitiesAPIClientError
query = {
"html": "<div class=\"test\">Hello & World</div>",
"action": "encode"
}
# Using context manager ensures proper cleanup
with HtmlentitiesAPIClient("[YOUR_API_KEY]") as api:
try:
result = api.execute(query)
print(result)
except HtmlentitiesAPIClientError as e:
print(f"Error: {e.message}")
# Session is automatically closed hereEnable debug logging to see detailed request and response information:
from apiverve_htmlentitiesencoder/decoder.apiClient import HtmlentitiesAPIClient
# Enable debug mode
api = HtmlentitiesAPIClient("[YOUR_API_KEY]", debug=True)
query = {
"html": "<div class=\"test\">Hello & World</div>",
"action": "encode"
}
# Debug information will be printed to console
result = api.execute(query)If you need to manually manage the session lifecycle:
from apiverve_htmlentitiesencoder/decoder.apiClient import HtmlentitiesAPIClient
api = HtmlentitiesAPIClient("[YOUR_API_KEY]")
query = {
"html": "<div class=\"test\">Hello & World</div>",
"action": "encode"
}
try:
result = api.execute(query)
print(result)
finally:
# Manually close the session when done
api.close()Need any assistance? Get in touch with Customer Support.
Stay up to date by following @apiverveHQ on Twitter.
All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.
Licensed under the The MIT License (MIT)
Copyright (©) 2026 APIVerve, and EvlarSoft LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.