Quickstart

1. Upload a CSV

On the homepage, drag and drop a CSV or click to select. The file must have a header row. We parse it and show a preview. Requirements: CSV format.

2. Check the preview

After upload you see a preview of your data and can try the API. The preview is time-limited. When you’re happy with it, proceed to create the API.

3. Create your API (account, plan, Stripe)

When you choose to create the API, you’re guided to create an account (if needed), then to pick a plan and complete payment via Stripe. After successful checkout, the API is created. The endpoint URL appears on the success page and in the dashboard.

4. Test the endpoint and use the dashboard

Copy the endpoint URL from the dashboard and call it with GET. In a browser, open it directly. From the command line:

       curl "https://api.getapibutler.com/v1/data/your-api-id" 
    

Replace your-api-id with the ID from your dashboard. Base URL may differ for your account; use the URL shown in the dashboard.

In the dashboard you can also update an API with a new CSV (replace its data) or delete an API.

Example response

Responses are JSON: a data array of rows and a meta object with pagination.

      { "data": [ { "id": "1", "name": "Widget A", "price": 9.99 }, { "id": "2", "name": "Widget B", "price": 14.99 } ], "meta": { "limit": 25, "offset": 0, "count": 2, "total": 2 } }
    

Full reference: API usage.