csvbase is a simple website for sharing table data. Join the discord.
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/thejeshgn/non-virus-deaths
Basic auth is widely supported and is usually accepted anywhere that accepts urls.
However, thejeshgn/non-virus-deaths is public so auth is needed only for writes.
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/thejeshgn/non-virus-deaths.json
This is useful when dealing with software where you aren't able to set headers.
There are three kinds of thing in csvbase:
While there's no API for users so far, there is for tables and rows.
This table looks like this in JSON:
{ "name": "non-virus-deaths", "is_public": true, "caption": "", "licence": "ODbL-1.0", "created": "2024-06-11T12:49:29.317645+01:00", "last_changed": "2024-06-11T12:49:29.317645+01:00", "columns": [ { "name": "csvbase_row_id", "type": "integer" }, { "name": "DB_LASTUPDATED_SET", "type": "string" }, { "name": "S. No", "type": "integer" }, { "name": "Incident Location", "type": "string" }, { "name": "District", "type": "string" }, { "name": "State/UT", "type": "string" }, { "name": "Date of incident", "type": "string" }, { "name": "No. of deaths", "type": "integer" }, { "name": "Reason of death", "type": "string" }, { "name": "Source", "type": "string" }, { "name": "Date of publication", "type": "string" }, { "name": "Link", "type": "string" }, { "name": "Category", "type": "string" }, { "name": "Name(s) and age", "type": "string" }, { "name": "Occupation\nCategory", "type": "string" } ], "approx_size": 623, "page": { "rows": [ { "row": { "DB_LASTUPDATED_SET": "SET_JUNE-13", "S. No": 1, "Incident Location": "Agra", "District": "Agra", "State/UT": "Uttar Pradesh", "Date of incident": "March 28,2020", "No. of deaths": 1, "Reason of death": "Exhaustion, Migration", "Source": "Times of India", "Date of publication": "March 28,2020", "Link": "https://m.timesofindia.com/city/agra/food-delivery-boy-dies-after-walking-200-kms-to-agra-from-delhi/amp_articleshow/74864379.cms?__twitter_impression=true", "Category": "DarkGreen", "Name(s) and age": "Ranveer Singh (39)", "Occupation\nCategory": "migrant worker- restaurant" }, "row_id": 1, "url": "https://csvbase.com/thejeshgn/non-virus-deaths/rows/1" } ], "previous_page_url": null, "next_page_url": "https://csvbase.com/thejeshgn/non-virus-deaths?op=gt&n=1" } }
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.
GET
from https://csvbase.com/thejeshgn/non-virus-deaths
You'll need to follow the next_page_url
urls (described
above) to get to the end of the table.
Rows from thejeshgn/non-virus-deaths look like this in JSON:
{ "row": { "DB_LASTUPDATED_SET": "SET_JUNE-13", "S. No": 1, "Incident Location": "Agra", "District": "Agra", "State/UT": "Uttar Pradesh", "Date of incident": "March 28,2020", "No. of deaths": 1, "Reason of death": "Exhaustion, Migration", "Source": "Times of India", "Date of publication": "March 28,2020", "Link": "https://m.timesofindia.com/city/agra/food-delivery-boy-dies-after-walking-200-kms-to-agra-from-delhi/amp_articleshow/74864379.cms?__twitter_impression=true", "Category": "DarkGreen", "Name(s) and age": "Ranveer Singh (39)", "Occupation\nCategory": "migrant worker- restaurant" }, "row_id": 1, "url": "https://csvbase.com/thejeshgn/non-virus-deaths/rows/1" }
POST
to https://<some_user>:<some_api_key>@csvbase.com/thejeshgn/non-virus-deaths/rows/
{ "row": { "DB_LASTUPDATED_SET": "SET_JUNE-13", "S. No": 1, "Incident Location": "Agra", "District": "Agra", "State/UT": "Uttar Pradesh", "Date of incident": "March 28,2020", "No. of deaths": 1, "Reason of death": "Exhaustion, Migration", "Source": "Times of India", "Date of publication": "March 28,2020", "Link": "https://m.timesofindia.com/city/agra/food-delivery-boy-dies-after-walking-200-kms-to-agra-from-delhi/amp_articleshow/74864379.cms?__twitter_impression=true", "Category": "DarkGreen", "Name(s) and age": "Ranveer Singh (39)", "Occupation\nCategory": "migrant worker- restaurant" } }
{ "row": { "DB_LASTUPDATED_SET": "SET_JUNE-13", "S. No": 1, "Incident Location": "Agra", "District": "Agra", "State/UT": "Uttar Pradesh", "Date of incident": "March 28,2020", "No. of deaths": 1, "Reason of death": "Exhaustion, Migration", "Source": "Times of India", "Date of publication": "March 28,2020", "Link": "https://m.timesofindia.com/city/agra/food-delivery-boy-dies-after-walking-200-kms-to-agra-from-delhi/amp_articleshow/74864379.cms?__twitter_impression=true", "Category": "DarkGreen", "Name(s) and age": "Ranveer Singh (39)", "Occupation\nCategory": "migrant worker- restaurant" }, "row_id": 1, "url": "https://csvbase.com/thejeshgn/non-virus-deaths/rows/1" }
Status code 201 upon success.
GET
from https://csvbase.com/thejeshgn/non-virus-deaths/rows/1
No body is provided with this request. Status code 200 upon success.
{ "row": { "DB_LASTUPDATED_SET": "SET_JUNE-13", "S. No": 1, "Incident Location": "Agra", "District": "Agra", "State/UT": "Uttar Pradesh", "Date of incident": "March 28,2020", "No. of deaths": 1, "Reason of death": "Exhaustion, Migration", "Source": "Times of India", "Date of publication": "March 28,2020", "Link": "https://m.timesofindia.com/city/agra/food-delivery-boy-dies-after-walking-200-kms-to-agra-from-delhi/amp_articleshow/74864379.cms?__twitter_impression=true", "Category": "DarkGreen", "Name(s) and age": "Ranveer Singh (39)", "Occupation\nCategory": "migrant worker- restaurant" }, "row_id": 1, "url": "https://csvbase.com/thejeshgn/non-virus-deaths/rows/1" }
PUT
to https://<some_user>:<some_api_key>@csvbase.com/thejeshgn/non-virus-deaths/rows/1
{ "row": { "DB_LASTUPDATED_SET": "SET_JUNE-13", "S. No": 1, "Incident Location": "Agra", "District": "Agra", "State/UT": "Uttar Pradesh", "Date of incident": "March 28,2020", "No. of deaths": 1, "Reason of death": "Exhaustion, Migration", "Source": "Times of India", "Date of publication": "March 28,2020", "Link": "https://m.timesofindia.com/city/agra/food-delivery-boy-dies-after-walking-200-kms-to-agra-from-delhi/amp_articleshow/74864379.cms?__twitter_impression=true", "Category": "DarkGreen", "Name(s) and age": "Ranveer Singh (39)", "Occupation\nCategory": "migrant worker- restaurant" }, "row_id": 1, "url": "https://csvbase.com/thejeshgn/non-virus-deaths/rows/1" }
Upon success the body you sent will be echoed back, with status code 200.
DELETE
from https://<some_user>:<some_api_key>@csvbase.com/thejeshgn/non-virus-deaths/rows/1
No body is required. Status code 204 upon success.