npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

canada-api

v5.0.0

Published

Cross platform API to fetch data from canada.ca

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

bsoicherbsoicher

Keywords

canadaapifetch

Readme

canada-api

NPM Version License: MIT

Cross platform API for fetching public data from canada.ca.

Browser

<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>

Node 18+

Install

npm install canada-api

Usage

import ca from 'canada-api'

Testing

npm test

Tests use the built-in Node.js test runner (node:test) and require Node 18 or later.

Core API

ca.normalize(url)

  • url {string|URL} - Full URL or relative path (e.g. '/en/page' or 'https://www.canada.ca/en/page')
  • Returns: {URL} Normalized URL object with cleaned pathname

Validates and normalizes a canada.ca URL. Strips the /content/canadasite prefix, file extensions, and trailing slashes.

Throws {TypeError} if url is not a string or URL object. Throws {Error} if the URL is not on canada.ca or the path does not start with /en/ or /fr/.

ca.request(url)

  • url {string|URL} - Relative or absolute URL on canada.ca
  • Returns: {Promise} Fulfills with an axios response object

Raw HTTP client for canada.ca. No URL transformation is applied.

{
  "data": {},
  "status": 200,
  "statusText": "OK",
  "headers": {},
  "config": {},
  "request": {}
}

Basic API

ca.children(url)

  • url {string|URL} - Absolute or relative URL
  • Returns: {Promise} Fulfills with an axios response whose data is an array of sitemap entries

Fetches and parses the sitemap for the given page, returning its child pages. Entries without a <loc> element are skipped.

{
  "data": [
    {
      "path": "/en/department-national-defence/maple-leaf",
      "lastmod": "2022-09-20T00:00:00.000Z"
    }
  ]
}

ca.content(url)

  • url {string|URL} - Absolute or relative URL
  • Returns: {Promise} Fulfills with an axios response whose data is the raw HTML string

Retrieves the HTML content of the page.

{
  "data": "<!DOCTYPE html>\r\n...."
}

ca.meta(url)

  • url {string|URL} - Absolute or relative URL
  • Returns: {Promise} Fulfills with an axios response whose data is a formatted metadata object

Fetches JCR metadata for the given page. The following transformations are applied:

  • String "true" / "false" values are converted to booleans
  • @TypeHint properties are removed
  • Empty arrays are removed
  • Date strings are converted to ISO 8601
  • Keys are sorted alphabetically
  • A normalized peer field is added when gcAltLanguagePeer is present
{
  "data": {
    "cq:lastModified": "2022-10-25T19:16:28.000Z",
    "fluidWidth": false,
    "peer": "/fr/ministere-defense-nationale/feuille-erable"
  }
}