Skip to content

BC Data Catalogue API API

by gov.bc.ca

API keyOpen Data
Open documentation ↗

Overview

This API provides live access to the BC Data Catalogue. Further documentation on the API is available from http://docs.ckan.org/en/latest/ Confirm the version of the API available from the catalogue by requesting https://catalogue.data.gov.bc.ca/api/3/action/status_show. Please note that you may experience issues when submitting requests to the delivery or test environment if using this [OpenAPI specification](https://github.com/bcgov/api-specs) in other API console viewers.

BC Data Catalogue API is an open data API from gov.bc.ca. Requests are authenticated with an API key. It is served over plain HTTP. Its OpenAPI description documents 22 endpoints.

At a glance

Authentication
API key
HTTPS
No
CORS
Unknown
Category
Open Data
Base URL
https://catalogue.data.gov.bc.ca/api/3
Version
3.0.1
Endpoints
22
Spec updated
2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://catalogue.data.gov.bc.ca/api/3/action/organization_activity_list" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://catalogue.data.gov.bc.ca/api/3/action/organization_activity_list", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://catalogue.data.gov.bc.ca/api/3/action/organization_activity_list",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/action/organization_activity_listGet the activity stream of an organization
GET/action/organization_activity_list_htmlGet the activity stream of an organization, HTML format
GET/action/organization_autocompleteGet names of organizations that match a query string
GET/action/organization_follower_countGet number of followers of an organization
GET/action/organization_follower_listGet users following an organization
GET/action/organization_listGet names of all organizations
GET/action/organization_list_for_userGet organizations that a user has a given permission for
GET/action/organization_revision_listGet organization revisions
GET/action/organization_showGet details of a specific organization
GET/action/package_activity_listGet the activity stream of a package (dataset)
GET/action/package_activity_list_htmlGet the activity stream of a package (dataset), HTML format
GET/action/package_autocompleteFind packages (datasets) matching a query
GET/action/package_listGet a list of all packages (datasets)
GET/action/package_relationships_listGet package (dataset) relationships
GET/action/package_revision_listGet list of revisions for a package (dataset)
GET/action/package_searchFind packages (datasets) matching query terms
GET/action/package_showGet metadata about one specific package (dataset)
GET/action/related_listGets items related to a package (dataset)
GET/action/resource_searchFind resources
GET/action/resource_showGet metadata for a specific resource
GET/action/status_showGet the site status
GET/action/tag_listGet a list of tags

Questions

Does the BC Data Catalogue API API need an API key?

Yes. The BC Data Catalogue API API uses API key authentication; the documentation explains how to get credentials.

Does the BC Data Catalogue API API support HTTPS?

The BC Data Catalogue API API is listed as HTTP only, so avoid sending secrets to it.

How many endpoints does the BC Data Catalogue API API have?

Its OpenAPI description lists 22 endpoints in version 3.0.1. All of them are shown on this page.

What are alternatives to the BC Data Catalogue API API?

Other Open Data APIs include Search Services, Wayback API, Wikipedia, Nasdaq Data Link, University of Oslo.

Compare alternatives →

Listed from APIs.guru (CC0).