Data Formats¶

2 endpoints for converting structured data between JSON, CSV, XML, YAML, and TOML — in any direction.

Python SDK Examples¶

JSON to YAML¶

from toolkitapi import Convert

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

result = cv.data(
    from_format="json",
    to_format="yaml",
    data={"name": "Alice", "scores": [95, 87, 92]},
)
print(result["result"])
# name: Alice
# scores:
# - 95
# - 87
# - 92

JSON array to CSV¶

from_format="json" with a list of objects flattens nested fields using dot notation (e.g. address.city).

from toolkitapi import Convert

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

result = cv.data(
    from_format="json",
    to_format="csv",
    data=[
        {"id": 1, "name": "Alice", "address": {"city": "London"}},
        {"id": 2, "name": "Bob",   "address": {"city": "Paris"}},
    ],
)
print(result["result"])
# id,name,address.city
# 1,Alice,London
# 2,Bob,Paris

CSV to JSON¶

from toolkitapi import Convert

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

csv_text = "name,age\nAlice,30\nBob,25"

result = cv.data(
    from_format="csv",
    to_format="json",
    data=csv_text,
    has_header=True,
)
print(result["result"])
# [{"name": "Alice", "age": "30"}, {"name": "Bob", "age": "25"}]

XML to JSON¶

from toolkitapi import Convert

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

xml_text = "<users><user><name>Alice</name><age>30</age></user></users>"

result = cv.data(
    from_format="xml",
    to_format="json",
    data=xml_text,
    strip_namespaces=True,
)
import json
print(json.dumps(json.loads(result["result"]), indent=2))

Convert from a remote URL and download the file¶

The _file variant fetches the source from a URL and streams the converted bytes back directly.

from toolkitapi import Convert

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

# Download a remote CSV and get it back as YAML bytes
path = cv.data_file(
    url="https://toolkitapi.io/data/products.csv",
    from_format="csv",
    to_format="yaml",
    has_header=True,
    output_path="products.yaml",
)
print(f"Saved to {path}")

TOML to JSON¶

from toolkitapi import Convert

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

toml_text = '[server]\nhost = "localhost"\nport = 8080'

result = cv.data(
    from_format="toml",
    to_format="json",
    data=toml_text,
)
print(result["result"])
# {"server": {"host": "localhost", "port": 8080}}

Request Parameters¶

Response Fields¶