Skip to main content

JSON to CSV Converter is a powerful tool for converting JSON arrays into CSV format. It supports custom delimiters, header inclusion, and proper escaping of special characters.

Project description

JSON to CSV Converter API

JSON to CSV Converter is a powerful tool for converting JSON arrays into CSV format. It supports custom delimiters, header inclusion, and proper escaping of special characters.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the JSON to CSV Converter API


Installation

Using pip:

pip install apiverve-jsontocsvconverter

Using pip3:

pip3 install apiverve-jsontocsvconverter

Configuration

Before using the jsontocsv API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_jsontocsvconverter.apiClient import JsontocsvAPIClient

# Initialize the client with your APIVerve API key
api = JsontocsvAPIClient("[YOUR_API_KEY]")

query = {
    "json": [{"name":"John Doe","age":30,"city":"New York"},{"name":"Jane Smith","age":25,"city":"Los Angeles"}],
    "delimiter": ",",
    "include_header": true
}

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The JSON to CSV Converter API documentation is found here: https://docs.apiverve.com/ref/jsontocsv. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_jsontocsvconverter.apiClient import JsontocsvAPIClient

# Initialize the client with your APIVerve API key
api = JsontocsvAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {
    "json": [{"name":"John Doe","age":30,"city":"New York"},{"name":"Jane Smith","age":25,"city":"Los Angeles"}],
    "delimiter": ",",
    "include_header": true
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "row_count": 2,
    "column_count": 3,
    "columns": [
      "name",
      "age",
      "city"
    ],
    "csv": "name,age,city\nJohn Doe,30,New York\nJane Smith,25,Los Angeles"
  }
}

Error Handling

The API client provides comprehensive error handling through the JsontocsvAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_jsontocsvconverter.apiClient import JsontocsvAPIClient, JsontocsvAPIClientError

api = JsontocsvAPIClient("[YOUR_API_KEY]")

query = {
    "json": [{"name":"John Doe","age":30,"city":"New York"},{"name":"Jane Smith","age":25,"city":"Los Angeles"}],
    "delimiter": ",",
    "include_header": true
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except JsontocsvAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_jsontocsvconverter.apiClient import JsontocsvAPIClient, JsontocsvAPIClientError

api = JsontocsvAPIClient("[YOUR_API_KEY]")

query = {
    "json": [{"name":"John Doe","age":30,"city":"New York"},{"name":"Jane Smith","age":25,"city":"Los Angeles"}],
    "delimiter": ",",
    "include_header": true
}

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except JsontocsvAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_jsontocsvconverter.apiClient import JsontocsvAPIClient, JsontocsvAPIClientError

query = {
    "json": [{"name":"John Doe","age":30,"city":"New York"},{"name":"Jane Smith","age":25,"city":"Los Angeles"}],
    "delimiter": ",",
    "include_header": true
}

# Using context manager ensures proper cleanup
with JsontocsvAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except JsontocsvAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_jsontocsvconverter.apiClient import JsontocsvAPIClient

# Enable debug mode
api = JsontocsvAPIClient("[YOUR_API_KEY]", debug=True)

query = {
    "json": [{"name":"John Doe","age":30,"city":"New York"},{"name":"Jane Smith","age":25,"city":"Los Angeles"}],
    "delimiter": ",",
    "include_header": true
}

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_jsontocsvconverter.apiClient import JsontocsvAPIClient

api = JsontocsvAPIClient("[YOUR_API_KEY]")

query = {
    "json": [{"name":"John Doe","age":30,"city":"New York"},{"name":"Jane Smith","age":25,"city":"Los Angeles"}],
    "delimiter": ",",
    "include_header": true
}

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_jsontocsvconverter-1.1.14.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_jsontocsvconverter-1.1.14-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_jsontocsvconverter-1.1.14.tar.gz.

File metadata

File hashes

Hashes for apiverve_jsontocsvconverter-1.1.14.tar.gz
Algorithm Hash digest
SHA256 929d436db05c34223c6db26168dc1053fd4068f871ba3468a88519b319eae8ff
MD5 2f75b2159d835a2f7709eab47b02e1c9
BLAKE2b-256 0f1b3203d3d850e7c5dc7dcbc174b8921bbd863204b771b727bcf3e591937a5d

See more details on using hashes here.

File details

Details for the file apiverve_jsontocsvconverter-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_jsontocsvconverter-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 5137062d1034677cc0d775aaa981112d417283307c11eb3b508e0e29135f9581
MD5 b49ea8a7e599f1f01b29e7cb18a24980
BLAKE2b-256 ca10a0d371b026dba1c719d720a36c04117222d11fd8a459aaeb5a698cd6d4a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page