Things to check before integrating
Before you integrate
Extract a simple table and remove layout-only merged cells before converting it.
Before you integrate
A text table is not suitable for reliable round-trip parsing when values contain line breaks or wide glyphs.
Code examples
These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.
HTML table to ASCII text table API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/html-to-ascii' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data=<table>
<tr>
<td>region</td>
<td>orders</td>
<td>revenue</td>
</tr>
<tr>
<td>North</td>
<td>42</td>
<td>1260</td>
</tr>
<tr>
<td>South</td>
<td>35</td>
<td>1050</td>
</tr>
</table>' \
--form-string 'output[style]=+++-,+++-,+++-,+++-,|' \
--form-string 'output[comment]=' \
--form-string 'output[forceSep]=false' \
--form-string 'output[align]=l' \
--output 'html-to-ascii.txt'Requires cURL. Download the sample input first when this example uploads a file.
HTML table to ASCII text table API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/html-to-ascii"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "<table>\n <tr>\n <td>region</td>\n <td>orders</td>\n <td>revenue</td>\n </tr>\n <tr>\n <td>North</td>\n <td>42</td>\n <td>1260</td>\n </tr>\n <tr>\n <td>South</td>\n <td>35</td>\n <td>1050</td>\n </tr>\n</table>"),
"output[style]": (None, "+++-,+++-,+++-,+++-,|"),
"output[comment]": (None, ""),
"output[forceSep]": (None, "false"),
"output[align]": (None, "l"),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("html-to-ascii.txt").write_bytes(response.content)Requires Python 3 and requests. Install it with pip install requests.
HTML table to ASCII text table API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "<table>\n <tr>\n <td>region</td>\n <td>orders</td>\n <td>revenue</td>\n </tr>\n <tr>\n <td>North</td>\n <td>42</td>\n <td>1260</td>\n </tr>\n <tr>\n <td>South</td>\n <td>35</td>\n <td>1050</td>\n </tr>\n</table>");
form.set("output[style]", "+++-,+++-,+++-,+++-,|");
form.set("output[comment]", "");
form.set("output[forceSep]", "false");
form.set("output[align]", "l");
const response = await fetch("https://api.tableconvert.com/v2/convert/html-to-ascii", {
method: "POST",
headers: { Authorization: "Bearer " + process.env.TABLECONVERT_API_KEY },
body: form,
signal: AbortSignal.timeout(40_000),
});
if (!response.ok) {
throw new Error("HTTP " + response.status + ": " + await response.text());
}
await writeFile("html-to-ascii.txt", Buffer.from(await response.arrayBuffer()));Requires Node.js 20 or later with built-in fetch, FormData and Blob.
Authentication
Send Authorization: Bearer YOUR_API_KEY. Let the HTTP client set the multipart boundary; do not set Content-Type manually.
Keep production API keys in server-side environment variables.
Request parameters
This importer extracts table, row and cell contents from HTML markup. It is a table-data converter, not a whole-page browser renderer.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | string | — | Inline HTML table content. Choose one of data, file or url. |
file | binary | — | Upload a html file using multipart/form-data. |
url | string | — | A supported publicly accessible HTTP or HTTPS file URL. |
Send one source: data, file, or url. The examples below use the source mode appropriate for this format.
Output options
Create a plain-text table with selectable borders, alignment and optional comment wrappers. It is a display representation, not a structured interchange format.
| Parameter | Type | Default | Description |
|---|---|---|---|
output[style] | string | +++-,+++-,+++-,+++-,| | Set the border-character pattern used to draw the plain-text grid. |
output[comment] | string | Empty string | Wrap the ASCII table in the chosen source-comment or code-fence markers. |
output[forceSep] | boolean | false | Draw a separator between each body row of the text table. |
output[align] | string | l | Choose left, center or right alignment for generated table cells. |
Conversion rules
| Case | Behavior |
|---|---|
| Mapping rule 1 | HTML tr elements become rows and th/td contents become cells after inner tags are removed. |
| Mapping rule 2 | The full header and data grid is padded into fixed-width columns. |
| Mapping rule 3 | Rebuild a table in the destination notation from extracted cells; original HTML styling and nested markup are not carried across. |
How the input is read
- Supply an HTML table containing explicit tr and th/td elements.
- Tags inside cells are stripped; CSS, links, images and page layout are not preserved as visual elements.
- Simplify colspan, rowspan and nested tables before conversion; the parser extracts cells rather than reconstructing browser layout.
- Multiple table elements are separate extracted tables; confirm which table your request converts.
How the output is written
- Column widths are calculated from cell text and padded with spaces.
- Use a monospaced font; wide Unicode glyphs may not align by visual width.
- Border and comment options change presentation without adding cell types.
When to use this API
This conversion in practice
Use an HTML report table as the starting dataset for a readable log or terminal report. Extract a simple table and remove layout-only merged cells before converting it.
ASCII text table
Embed query results in logs, terminal output or source comments.
Responses and errors
| HTTP status | Description |
|---|---|
200 | text/plain; charset=utf-8 |
400 | Invalid input or conversion parameters. |
402 | Insufficient credits for this request. |
403 | Missing or invalid API key. |
413 | The input exceeds the configured request limit. |
415 | Unsupported input media type. |
429 | Rate limit exceeded. |
500 | The conversion could not be completed. |
503 | The renderer is unavailable or the request timed out. |
Check the response before retrying. A new HTTP request is a new conversion and may use credits again.
Limits, billing and versions
Local previews accept up to 200 KB. The current API implementation allows one uploaded file up to 50 MiB, limits each multipart text field to 1 MiB, and gives v2 conversion tasks a 30-second deadline. Deployment limits may be stricter. Read the returned error before retrying; some parser or renderer failures return HTTP 500.
Live calls follow the API credit policy. Failed conversions are refunded; a completed conversion is not undone if the download connection later fails.
View API pricing and creditsUsing API v1?
This page documents v2, which returns the output directly. API v1 wraps the result in a JSON envelope. Check the overview before changing an existing integration.
API overviewReferences and format specifications
Format references explain the underlying syntax. The conversion rules and samples above describe TableConvert’s implementation.