Bc

BC Data Catalogue API

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…

Government & public#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

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 in other API console viewers.

Endpoints 22

action

  • GETGet the activity stream of an organization/action/organization_activity_list?id=ministry-of-agricultureReturn an organization's activity stream
  • GETGet the activity stream of an organization, HTML format/action/organization_activity_list_html?id=ministry-of-agricultureReturn an organization's activity stream as HTML
  • GETGet names of organizations that match a query string/action/organization_autocomplete?q=ministry&limit=20Return a list of organization names that contain a string
  • GETGet number of followers of an organization/action/organization_follower_count?id=ministry-of-agricultureReturn the number of followers of an organization
  • GETGet users following an organization/action/organization_follower_list?id=ministry-of-agricultureReturn a list of users that are following a given organization
  • GETGet names of all organizations/action/organization_list?offset=0&limit=100Returns the names of all indexed organizations
  • GETGet organizations that a user has a given permission for/action/organization_list_for_user?permission="edit_group"Return the organizations that the user has a given permission for
  • GETGet organization revisions/action/organization_revision_list?id=ministry-of-agricultureReturn an organization's revisions
  • GETGet details of a specific organization/action/organization_show?id=ministry-of-agriculture&include_datasets=trueReturn the details of an organization
  • GETGet the activity stream of a package (dataset)/action/package_activity_list?id=grizzly-bear-population-units&offset=0&limit=31Returns a package's activity stream
  • GETGet the activity stream of a package (dataset), HTML format/action/package_activity_list_html?id=grizzly-bear-population-units&offset=0&limit=31The activity stream is rendered as a snippet of HTML meant to be included in an HTML pag, i.e it doesn't have any header or footer.
  • GETFind packages (datasets) matching a query/action/package_autocomplete?q="Okanagan Lake"&limit=10Return a list of datasets that match a string
  • GETGet a list of all packages (datasets)/action/package_list?offset=0&limit=100Returns the names of all indexed packages (datasets)
  • GETGet package (dataset) relationships/action/package_relationships_list?id=grizzly-bear-population-units&id2=important-fossil-areas&rel=stringReturn a dataset's relationships
  • GETGet list of revisions for a package (dataset)/action/package_revision_list?id=grizzly-bear-population-unitsReturn a dataset's revision as a list of dictionaries
  • GETFind packages (datasets) matching query terms/action/package_search?q="Okanagan Lake"Searches for packages (datasets) matching the specified query terms
  • GETGet metadata about one specific package (dataset)/action/package_show?id=grizzly-bear-population-unitsReturns metadata about the package (dataset) corresponding to the specified unique name
  • GETGets items related to a package (dataset)/action/related_list?id=string&dataset=string&type_filter=string&sort=string&featured=stringReturns a dataset's related items.
  • GETFind resources/action/resource_search?query=format:csv&fields=string&order_by=string&offset=0&limit=0Returns a dictionary with two fields count and results. The count field contains the total number of Resources found without the limit or query parameters…
  • GETGet metadata for a specific resource/action/resource_show?id=e6c8bb1d-3726-418b-9b7e-1d97a9bbb817&include_tracking=falseReturn the metadata of a resource
  • GETGet the site status/action/status_showReturns the site status
  • GETGet a list of tags/action/tag_list?offset=0&limit=100Returns the names of all indexed tags

API details

Base URL
https://catalogue.data.gov.bc.ca/api/3
https://cat.data.gov.bc.ca/api/3
https://cad.data.gov.bc.ca/api/3
Authentication
OAuth 2.0 (authorization code flow) with 19 scopes
An API key in the ckan_api_key header
Operations
22 operations on 22 pathsGET 22
Main resources
action 22
Description format
OpenAPI 3.0.0, API version 3.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the BC Data Catalogue API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BC Data Catalogue API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 19 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get the activity stream of an organization” (GET /action/organization_activity_list?id=ministry-of-agriculture), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BC Data Catalogue API?

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… It is listed under Government & public and has 22 endpoints.

Who publishes the BC Data Catalogue API?

It is listed from Bc's public API description (an OpenAPI document), not published by Bc on Swastik Codes. Anyone who controls gov.bc.ca can claim the profile by adding a DNS TXT record.

What is the base URL of the BC Data Catalogue API?

Its description lists 3 base URLs: https://catalogue.data.gov.bc.ca/api/3, https://cat.data.gov.bc.ca/api/3, https://cad.data.gov.bc.ca/api/3. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the BC Data Catalogue API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 19 scopes; an API key in the ckan_api_key header.

How many endpoints does the BC Data Catalogue API have?

22 operations on 22 paths (22 GET). The largest groups are action.

Is forking the BC Data Catalogue API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.