Things to check before integrating
Before you integrate
Select and flatten the required record fields before sending nested JSON.
Before you integrate
This regenerates cell data; it does not preserve source formulas, charts or original workbook formatting.
Before you integrate
The public API applies autoWidth and sheetName. The web-only textFormat and protectSheet settings do not change this API output.
Code examples
These examples send the sample as multipart/form-data and save the returned bytes unchanged. Set TABLECONVERT_API_KEY in your environment.
JSON to Excel XLSX API · cURL
curl --fail-with-body --max-time 40 \
'https://api.tableconvert.com/v2/convert/json-to-excel' \
--header "Authorization: Bearer $TABLECONVERT_API_KEY" \
--form-string 'data=[
{
"sku": "P101",
"item": "Notebook",
"stock": "12"
},
{
"sku": "P102",
"item": "Marker",
"stock": "8"
}
]' \
--form-string 'output[autoWidth]=true' \
--form-string 'output[sheetName]=Sheet 1' \
--output 'json-to-excel.xlsx'Requires cURL. Download the sample input first when this example uploads a file.
JSON to Excel XLSX API · Python
import os
from pathlib import Path
import requests
endpoint = "https://api.tableconvert.com/v2/convert/json-to-excel"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
"data": (None, "[\n {\n \"sku\": \"P101\",\n \"item\": \"Notebook\",\n \"stock\": \"12\"\n },\n {\n \"sku\": \"P102\",\n \"item\": \"Marker\",\n \"stock\": \"8\"\n }\n]"),
"output[autoWidth]": (None, "true"),
"output[sheetName]": (None, "Sheet 1"),
}
response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("json-to-excel.xlsx").write_bytes(response.content)Requires Python 3 and requests. Install it with pip install requests.
JSON to Excel XLSX API · Node.js
import { writeFile } from "node:fs/promises";
const form = new FormData();
form.set("data", "[\n {\n \"sku\": \"P101\",\n \"item\": \"Notebook\",\n \"stock\": \"12\"\n },\n {\n \"sku\": \"P102\",\n \"item\": \"Marker\",\n \"stock\": \"8\"\n }\n]");
form.set("output[autoWidth]", "true");
form.set("output[sheetName]", "Sheet 1");
const response = await fetch("https://api.tableconvert.com/v2/convert/json-to-excel", {
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("json-to-excel.xlsx", 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
A nonempty array of flat objects is the clearest record input. Object keys form a union of columns; nested structures are not automatically flattened.
| Parameter | Type | Default | Description |
|---|---|---|---|
data | string | — | Inline JSON table content. Choose one of data, file or url. |
file | binary | — | Upload a json 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 an XLSX workbook containing the normalized table. Output is a new data workbook rather than a copy of the original spreadsheet design.
| Parameter | Type | Default | Description |
|---|---|---|---|
output[autoWidth] | boolean | true | Estimate worksheet column widths from the extracted cell text. |
output[sheetName] | string | Sheet 1 | Name the generated worksheet; obey Excel worksheet-name restrictions. |
Conversion rules
| Case | Behavior |
|---|---|
| Mapping rule 1 | The union of object keys forms the header, and each flat object supplies one row of text cells. |
| Mapping rule 2 | The normalized grid is written to a new worksheet, with optional width and sheet settings. |
| Mapping rule 3 | Flatten nested JSON before rendering and choose the required columns; the output shows the flat grid rather than the full object tree. |
How the input is read
- For object arrays, columns follow keys in first-seen order; missing keys yield empty cells.
- null becomes the literal text null, while numbers and booleans become text during table normalization.
- A nested object becomes [object Object]; an array inside a field becomes comma-joined text rather than additional rows.
- Prepare explicit flat fields before conversion; the endpoint has no generic flatten parameter.
How the output is written
- Write the binary response to an .xlsx file rather than interpreting it as JSON or plain CSV.
- Cells come from normalized table values; original formulas, styles, chart objects and relationships are not reconstructed.
- The public API applies autoWidth and sheetName. The web-only textFormat and protectSheet settings do not change this API output.
When to use this API
This conversion in practice
Use an application JSON response as the starting dataset for a spreadsheet review or handoff. Select and flatten the required record fields before sending nested JSON.
Excel XLSX
Deliver a simple workbook to a spreadsheet-based review workflow.
Responses and errors
| HTTP status | Description |
|---|---|
200 | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
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.