Spreadsheets¶

2 endpoints for converting between CSV, XLSX, XLS, ODS, XLSM, and JSON.

Python SDK Examples¶

CSV to XLSX¶

Pass CSV as an inline string via data.

from toolkitapi import Convert

cv = Convert(api_key="tk_...")

csv_text = "Product,Q1,Q2,Q3\nWidgets,1200,1450,1380\nGadgets,890,920,1010"

result = cv.spreadsheet(
    from_format="csv",
    to_format="xlsx",
    data=csv_text,
    sheet_name="Sales",
)

import base64
from pathlib import Path
xlsx_bytes = base64.b64decode(result["result"])
Path("sales.xlsx").write_bytes(xlsx_bytes)

XLSX to CSV¶

import base64
from pathlib import Path
from toolkitapi import Convert

cv = Convert(api_key="tk_...")

xlsx_bytes = Path("report.xlsx").read_bytes()

result = cv.spreadsheet(
    from_format="xlsx",
    to_format="csv",
    file=base64.b64encode(xlsx_bytes).decode(),
)

print(result["result"])
# Product,Q1,Q2,Q3
# Widgets,1200,1450,1380
# Gadgets,890,920,1010

JSON to XLSX¶

Convert a JSON array of objects directly to a spreadsheet.

from toolkitapi import Convert

cv = Convert(api_key="tk_...")

records = [
    {"name": "Alice", "department": "Engineering", "salary": 95000},
    {"name": "Bob",   "department": "Design",      "salary": 82000},
    {"name": "Carol", "department": "Marketing",   "salary": 78000},
]

result = cv.spreadsheet(
    from_format="json",
    to_format="xlsx",
    data=records,
    sheet_name="Employees",
)

import base64
from pathlib import Path
Path("employees.xlsx").write_bytes(base64.b64decode(result["result"]))

XLSX to JSON¶

import base64
from pathlib import Path
import json
from toolkitapi import Convert

cv = Convert(api_key="tk_...")

xlsx_bytes = Path("employees.xlsx").read_bytes()

result = cv.spreadsheet(
    from_format="xlsx",
    to_format="json",
    file=base64.b64encode(xlsx_bytes).decode(),
)

rows = json.loads(result["result"])
for row in rows:
    print(row)

Convert from a URL and download directly¶

Use spreadsheet_file() to stream the converted file to disk without base64 overhead.

from toolkitapi import Convert

cv = Convert(api_key="tk_...")

path = cv.spreadsheet_file(
    url="https://toolkitapi.io/data/quarterly-report.csv",
    from_format="csv",
    to_format="xlsx",
    sheet_name="Q Report",
    output_path="quarterly-report.xlsx",
)
print(f"Saved to {path}")

Convert a tab-separated file¶

Specify delimiter explicitly when the CSV uses a non-standard separator.

from toolkitapi import Convert

cv = Convert(api_key="tk_...")

tsv_text = "name\tscore\nAlice\t95\nBob\t87"

result = cv.spreadsheet(
    from_format="csv",
    to_format="xlsx",
    data=tsv_text,
    delimiter="\t",
)

Request Parameters¶

Response Fields¶