Things to check before integrating
Before you integrate
Place the intended sheet first, or upload it as a separate workbook; inspect dates and leading-zero identifiers in the extracted values.
Before you integrate
Invalid header names, raw ampersands and CDATA terminators require review before XML validation.
Code examples
These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.
Excel to XML records API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/excel-to-xml' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form 'file=@excel-to-xml-input.xlsx' \
--form-string 'output[minify]=false' \
--form-string 'output[escape]=true' \
--form-string 'output[rootElement]=dataset' \
--form-string 'output[rowElement]=record' \
--form-string 'output[declaration]=true' \
--form-string 'output[attributes]=false' \
--form-string 'output[cdata]=false' \
--form-string 'output[encoding]=UTF-8' \
--form-string 'output[indentSize]=2' \
--output 'excel-to-xml.xml'Requires cURL. Download the sample input first when this example uploads a file.
Excel to XML records API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/excel-to-xml"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"output[minify]": (None, "false"),
"output[escape]": (None, "true"),
"output[rootElement]": (None, "dataset"),
"output[rowElement]": (None, "record"),
"output[declaration]": (None, "true"),
"output[attributes]": (None, "false"),
"output[cdata]": (None, "false"),
"output[encoding]": (None, "UTF-8"),
"output[indentSize]": (None, "2"),
}
with open("excel-to-xml-input.xlsx", "rb") as source:
files = {**fields, "file": ("excel-to-xml-input.xlsx", source)}
response = requests.post(endpoint, headers=headers, files=files, timeout=40)
response.raise_for_status()
Path("excel-to-xml.xml").write_bytes(response.content)Requires Python 3 and requests. Install it with pip install requests.
Excel to XML records API · Node.js
import { readFile, writeFile } from "node:fs/promises";
const form = new FormData();
form.set("file", new Blob([await readFile("excel-to-xml-input.xlsx")]), "excel-to-xml-input.xlsx");
form.set("output[minify]", "false");
form.set("output[escape]", "true");
form.set("output[rootElement]", "dataset");
form.set("output[rowElement]", "record");
form.set("output[declaration]", "true");
form.set("output[attributes]", "false");
form.set("output[cdata]", "false");
form.set("output[encoding]", "UTF-8");
form.set("output[indentSize]", "2");
const response = await fetch("https://api.tableconvert.com/v2/convert/excel-to-xml", {
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("excel-to-xml.xml", 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
The API reads the first worksheet of an uploaded workbook as cell values and normalizes it into table rows. It does not preserve the workbook’s formulas, charts or visual design.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | string | — | For workbook input, use file or url. The example uploads a real .xlsx workbook. |
file | binary | — | Upload a xlsx 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
Generate a root element containing row elements with either child-field elements or attributes. This is a tabular XML representation rather than arbitrary source-tree reconstruction.
| Parameter | Type | Default | Description |
|---|---|---|---|
output[minify] | boolean | false | Reduce generated layout whitespace; inspect any format-specific effects on cell content. |
output[escape] | boolean | true | Escape characters meaningful to the destination markup when cells should remain plain text. |
output[rootElement] | string | dataset | Name the root XML element containing all generated records. |
output[rowElement] | string | record | Name each record element inside the XML root. |
output[declaration] | boolean | true | Include an XML declaration before the generated root element. |
output[attributes] | boolean | false | Represent XML row fields as attributes rather than child elements. |
output[cdata] | boolean | false | Place element text in CDATA sections; inspect values containing the CDATA terminator. |
output[encoding] | string | UTF-8 | Set the XML declaration’s encoding label; verify it matches how you save the response bytes. |
output[indentSize] | string | 2 | Set generated text indentation; it controls formatting rather than data types. |
Conversion rules
| Case | Behavior |
|---|---|
| Mapping rule 1 | The first worksheet’s values become rows and columns, with the first extracted row available as the destination header. |
| Mapping rule 2 | Header names become child-element or attribute names under each generated row element. |
| Mapping rule 3 | A worksheet header becomes record keys; choose unique names and explicitly decide how displayed dates should be represented. |
How the input is read
- Place the intended data in the first worksheet, using a simple rectangular range with a deliberate first-row header.
- The conversion uses extracted cell values, not the spreadsheet as an executable calculation model.
- Only the first extracted worksheet is converted. There is no input sheet-selection parameter, and workbook sheets are not merged.
- Review date displays, leading zeros and large identifiers after extraction; original Excel types and formatting do not transfer to every target.
How the output is written
- Header values become field names, while rootElement and rowElement name the surrounding nodes.
- Choose attributes or child elements deliberately, and keep XML escaping enabled for plain text.
- Validate element names and CDATA terminators; naming an encoding does not recreate original XML metadata.
When to use this API
This conversion in practice
Use a worksheet export as the starting dataset for an XML import payload. Place the intended sheet first, or upload it as a separate workbook; inspect dates and leading-zero identifiers in the extracted values.
XML records
Prepare a simple record-oriented payload for an XML import interface.
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.