QuickAPI Documentation

QuickAPI offers an easy way to convert CSV files into fully operational REST APIs. This documentation explains how to create, configure, and query APIs with QuickAPI, allowing for organized and efficient access to CSV data using typical REST endpoints, with authentication, user management, automatic type inference, among other cool features.

Getting Started with QuickAPI

QuickAPI is different from typical tools that only convert CSV data to JSON. It allows users to create a fully functional REST API with minimal effort. By following a few simple steps, users can upload a CSV file, and let QuickAPI automatically detect the data types for you, and quickly generate an API that is ready for queries.

Steps to Create an API

Register for a free account at QuickAPI https://quickapi.io/signup
Choose an appropriate name for your project.
Upload your CSV file and let QuickAPI take care of inferring the correct datatypes for your data.

The list of possible data types is as follows:
- INTEGER.
  - The value is a signed integer, stored in 0, 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of the value.
- REAL.
  - The value is a floating point value, stored as an 8-byte IEEE floating point number.
- TEXT.
  - The value is a text string, stored using the UTF-8 encoding.
  - Dates are also represented as a string since it is not a valid JSON datatype.
- BOOLEAN.
  - The value is a boolean type, recognized using the keywords TRUE and FALSE.
- NULL.
  - The value is a NULL value.
Create the related endpoint that you will be able to call to query your data.
You can now query your CSV file like any other API.

QuickAPI’s CSV endpoints are GET only, which means you cannot create, update or delete data, you can only query your data.

Querying the API

Basic equality

In the above example, the step column is a number (INTEGER), so you can search by equality. Try adding &step=4 at the end of the URL.

https://demo.quickapi.io/api/sample-csv?qapikey=YOUR_API_KEY&step=4

https://demo.quickapi.io/api/sample-csv?qapikey=YOUR_API_KEY&step=4

If you try to add a search to a column that does not exist in your data structure, it will simply be ignored and return the data as it was without adding any filters, until you add a column that does exist in your schema.

You can also chain two or more search filters together:

https://demo.quickapi.io/api/sample-csv?qapikey=YOUR_API_KEY&step=4&instruction="This%20is%20an%20exact%20match"

https://demo.quickapi.io/api/sample-csv?qapikey=YOUR_API_KEY&step=4&instruction="This%20is%20an%20exact%20match"

Pagination

By default, every result will be limited to 20 results. You can specify your own limit with the page and pageSize query arguments.

https://demo.quickapi.io/api/sample-csv?qapikey=YOUR_API_KEY&page=2&pageSize=200

https://demo.quickapi.io/api/sample-csv?qapikey=YOUR_API_KEY&page=2&pageSize=200

Parameters:

page.
- Represents the current page number.
- Starts from 1.
- Determines which subset of the data is retrieved.
pageSize.
- Represents the number of records per page.
- Controls how many items are returned in a single API response.
- Default to 20.
- Maximum of 200.

Pagination Calculation

The following formula is used to fetch the correct subset of data:

offset = (page - 1) * pageSize

offset = (page - 1) * pageSize

Page 1 → offset = (1-1) * 5 = 0 (fetch 1-5)
Page 2 → offset = (2-1) * 5 = 5 (fetch 6-10)
Page 3 → offset = (3-1) * 5 = 10 (fetch 11-15)

Knowing your schema

To know your schema and other useful metadata, like column name, type, if it accepts null or not, for example, on your datasource you can use the following endpoint:

https://demo.quickapi.io/api/sample-csv/schema?qapikey=YOUR_API_KEY

https://demo.quickapi.io/api/sample-csv/schema?qapikey=YOUR_API_KEY

Just add /schema to the end of the URL.

Example response:

[
    {
        "cid": 0,
        "name": "poll_id",
        "type": "BIGINT",
        "notnull": 0,
        "dflt_value": null,
        "pk": 0
    },
    {
        "cid": 1,
        "name": "pollster_id",
        "type": "BIGINT",
        "notnull": 0,
        "dflt_value": null,
        "pk": 0
    },
    {
        "cid": 2,
        "name": "pollster",
        "type": "TEXT",
        "notnull": 0,
        "dflt_value": null,
        "pk": 0
    }
]

[
    {
        "cid": 0,
        "name": "poll_id",
        "type": "BIGINT",
        "notnull": 0,
        "dflt_value": null,
        "pk": 0
    },
    {
        "cid": 1,
        "name": "pollster_id",
        "type": "BIGINT",
        "notnull": 0,
        "dflt_value": null,
        "pk": 0
    },
    {
        "cid": 2,
        "name": "pollster",
        "type": "TEXT",
        "notnull": 0,
        "dflt_value": null,
        "pk": 0
    }
]