canada-api
v5.1.5
Published
Cross platform API to fetch data from canada.ca
Downloads
911
Readme
(Français)
canada-api
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-apiUsage
import ca from 'canada-api'Testing
npm testTests use the built-in Node.js test runner (node:test) and require Node 18 or later.
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.children(url)
url{string|URL} - Absolute or relative URL- Returns: {Promise} Fulfills with a response whose
datais 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"
}
],
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "text/xml"
}
}ca.content(url)
url{string|URL} - Absolute or relative URL- Returns: {Promise} Fulfills with a response whose
datais the raw HTML string
Retrieves the HTML content of the page.
{
"data": "<!DOCTYPE html>...",
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "text/html"
}
}ca.meta(url)
url{string|URL} - Absolute or relative URL- Returns: {Promise} Fulfills with a response whose
datais a formatted metadata object
Fetches JCR metadata for the given page. The following transformations are applied:
- String
"true"/"false"values are converted to booleans @TypeHintproperties are removed- Empty arrays are removed
- Date strings are converted to ISO 8601
- Keys are sorted alphabetically
- A normalized
peerfield is added whengcAltLanguagePeeris present
{
"data": {
"cq:lastModified": "2022-10-25T19:16:28.000Z",
"fluidWidth": false,
"peer": "/fr/ministere-defense-nationale/feuille-erable"
},
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "application/json"
}
}ca.request
url{string|URL} - Absolute or relative URLoptions{RequestInit} - Optional fetch options- Returns: {Promise} Fulfills with a response object
Raw HTTP client with https://www.canada.ca as the base URL. Use this for any requests not covered by the methods above. No URL transformation is applied. Response bodies with a application/json content type are automatically parsed.
const response = await ca.request('/en/department-national-defence.html');All methods return the same response shape:
{
"data": "...",
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "text/html"
}
}canada-api
API multiplateforme pour récupérer des données publiques de canada.ca.
Navigateur
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>Node 18+
Installation
npm install canada-apiUtilisation
import ca from 'canada-api'API
ca.normalize(url)
url{string|URL} - URL complète ou chemin relatif (p. ex.'/fr/page'ou'https://www.canada.ca/fr/page')- Retourne: {URL} Objet URL normalisé avec un chemin nettoyé
Valide et normalise une URL de canada.ca. Supprime le préfixe /content/canadasite, les extensions de fichier et les barres obliques finales.
Lève {TypeError} si url n'est pas une chaîne ou un objet URL.
Lève {Error} si l'URL n'est pas sur canada.ca ou si le chemin ne commence pas par /en/ ou /fr/.
ca.children(url)
url{string|URL} - URL absolue ou relative- Retourne: {Promise} Résout avec une réponse dont
dataest un tableau d'entrées du plan de site
Récupère et analyse le plan de site de la page donnée, retournant ses pages enfants. Les entrées sans élément <loc> sont ignorées.
{
"data": [
{
"path": "/fr/ministere-defense-nationale/feuille-erable",
"lastmod": "2022-09-20T00:00:00.000Z"
}
],
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "text/xml"
}
}ca.content(url)
url{string|URL} - URL absolue ou relative- Retourne: {Promise} Résout avec une réponse dont
dataest la chaîne HTML brute
Récupère le contenu HTML de la page.
{
"data": "<!DOCTYPE html>...",
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "text/html"
}
}ca.meta(url)
url{string|URL} - URL absolue ou relative- Retourne: {Promise} Résout avec une réponse dont
dataest un objet de métadonnées formaté
Récupère les métadonnées JCR de la page donnée. Les transformations suivantes sont appliquées :
- Les valeurs
"true"/"false"sont converties en booléens - Les propriétés
@TypeHintsont supprimées - Les tableaux vides sont supprimés
- Les chaînes de date sont converties en ISO 8601
- Les clés sont triées alphabétiquement
- Un champ
peernormalisé est ajouté lorsquegcAltLanguagePeerest présent
{
"data": {
"cq:lastModified": "2022-10-25T19:16:28.000Z",
"fluidWidth": false,
"peer": "/en/department-national-defence/maple-leaf"
},
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "application/json"
}
}ca.request
url{string|URL} - URL absolue ou relativeoptions{RequestInit} - Options fetch optionnelles- Retourne: {Promise} Résout avec un objet réponse
Client HTTP brut avec https://www.canada.ca comme URL de base. Utilisez-le pour toute requête non couverte par les méthodes ci-dessus. Aucune transformation d'URL n'est appliquée. Les corps de réponse avec un type de contenu application/json sont automatiquement analysés.
const response = await ca.request('/fr/ministere-defense-nationale.html');Toutes les méthodes retournent la même structure de réponse :
{
"data": "...",
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "text/html"
}
}