calpaterson / palmer-penguins Public domain

Table of contents

1. The basics: auth and content negotations
   1. Authentication
   2. Content negotiation
2. The API: endpoint-by-endpoint
   1. Tables
      1. Reading a table
   2. Rows
      1. Creating a new row
      2. Reading a row
      3. Updating an existing row
      4. Deleting a row

The basics: auth and content negotiation

Authentication

With CSVBase, you authenticate using by putting your username and API key straight in the url (known as "HTTP "basic" auth").

Here's an example:

https://<some_user>:<some_api_key>@csvbase.com/calpaterson/palmer-penguins

Basic auth is widely supported and is usually accepted anywhere that accepts urls.

However, calpaterson/palmer-penguins is public so auth is needed only for writes.

Content negotiation

CSVBase APIs use content negotiation to decide what formats are in use. This means it consults HTTP headers to decide what format to send back in response to a request.

It important that you set the Content-Type and Accept headers to be the mimetype you want: typically that is application/json for both. If you fail to include these headers in your requests, the API will still work but CSVBase will pick a sensible default: CSV for tables, JSON for rows.

You can bypass content negotiation for read-only requests by appending a file extension to the url, eg .json. Here's an example of that (same resource as above):

https://<some_user>:<some_api_key>@csvbase.com/calpaterson/palmer-penguins/export/json

This is useful when dealing with software where you aren't able to set headers.

The API: endpoint-by-endpoint

There are three kinds of thing in csvbase:

1. users
2. tables
3. rows

While there's no API for users so far, there is for tables and rows.

Tables

This table looks like this in JSON:

{
    "name": "palmer-penguins",
    "is_public": true,
    "caption": "344 penguin measurements, collected 2007-2009 at Palmer Station, Antartica",
    "data_licence": "Public domain",
    "created": "2022-12-22T15:32:56.127005+00:00",
    "last_changed": "2022-12-22T15:32:56.127005+00:00",
    "columns": [
        {
            "name": "csvbase_row_id",
            "type": "integer"
        },
        {
            "name": "species",
            "type": "string"
        },
        {
            "name": "island",
            "type": "string"
        },
        {
            "name": "bill_length_mm",
            "type": "float"
        },
        {
            "name": "bill_depth_mm",
            "type": "float"
        },
        {
            "name": "flipper_length_mm",
            "type": "float"
        },
        {
            "name": "body_mass_g",
            "type": "float"
        },
        {
            "name": "sex",
            "type": "string"
        },
        {
            "name": "year",
            "type": "integer"
        }
    ],
    "page": {
        "rows": [
            {
                "row": {
                    "species": "Adelie",
                    "island": "Torgersen",
                    "bill_length_mm": 39.1,
                    "bill_depth_mm": 18.7,
                    "flipper_length_mm": 181.0,
                    "body_mass_g": 3750.0,
                    "sex": "male",
                    "year": 2007
                },
                "row_id": 1,
                "url": "https://csvbase.com/calpaterson/palmer-penguins/rows/1"
            }
        ],
        "previous_page_url": null,
        "next_page_url": "https://csvbase.com/calpaterson/palmer-penguins?op=gt&n=1"
    },
    "approx_size": 344
}

Note that there is the top-level metadata, plus a "page" of rows. Tables are often (usually) too big to be put into a single JSON object so they are "paginated". To follow the table, page by page, you can use the next_page_url and previous_page_url dictionary keys. They will be null if you've reached the end or are at the beginning, respectively.

Reading a table

GET from https://csvbase.com/calpaterson/palmer-penguins

You'll need to follow the next_page_url urls (described above) to get to the end of the table.

Rows

Rows from calpaterson/palmer-penguins look like this in JSON:

{
    "row": {
        "species": "Adelie",
        "island": "Torgersen",
        "bill_length_mm": 39.1,
        "bill_depth_mm": 18.7,
        "flipper_length_mm": 181.0,
        "body_mass_g": 3750.0,
        "sex": "male",
        "year": 2007
    },
    "row_id": 1,
    "url": "https://csvbase.com/calpaterson/palmer-penguins/rows/1"
}

Creating a new row

POST to https://<some_user>:<some_api_key>@csvbase.com/calpaterson/palmer-penguins/rows/

Example body

{
    "row": {
        "species": "Adelie",
        "island": "Torgersen",
        "bill_length_mm": 39.1,
        "bill_depth_mm": 18.7,
        "flipper_length_mm": 181.0,
        "body_mass_g": 3750.0,
        "sex": "male",
        "year": 2007
    }
}

Example response

{
    "row": {
        "species": "Adelie",
        "island": "Torgersen",
        "bill_length_mm": 39.1,
        "bill_depth_mm": 18.7,
        "flipper_length_mm": 181.0,
        "body_mass_g": 3750.0,
        "sex": "male",
        "year": 2007
    },
    "row_id": 1,
    "url": "https://csvbase.com/calpaterson/palmer-penguins/rows/1"
}

Status code 201 upon success.

Reading a row

GET from https://csvbase.com/calpaterson/palmer-penguins/rows/1

No body is provided with this request. Status code 200 upon success.

Example response

{
    "row": {
        "species": "Adelie",
        "island": "Torgersen",
        "bill_length_mm": 39.1,
        "bill_depth_mm": 18.7,
        "flipper_length_mm": 181.0,
        "body_mass_g": 3750.0,
        "sex": "male",
        "year": 2007
    },
    "row_id": 1,
    "url": "https://csvbase.com/calpaterson/palmer-penguins/rows/1"
}

Updating an existing row

PUT to https://<some_user>:<some_api_key>@csvbase.com/calpaterson/palmer-penguins/rows/1

Example body

{
    "row": {
        "species": "Adelie",
        "island": "Torgersen",
        "bill_length_mm": 39.1,
        "bill_depth_mm": 18.7,
        "flipper_length_mm": 181.0,
        "body_mass_g": 3750.0,
        "sex": "male",
        "year": 2007
    },
    "row_id": 1,
    "url": "https://csvbase.com/calpaterson/palmer-penguins/rows/1"
}

Response

Upon success the body you sent will be echoed back, with status code 200.

Deleting a row

DELETE from https://<some_user>:<some_api_key>@csvbase.com/calpaterson/palmer-penguins/rows/1

No body is required. Status code 204 upon success.