{"id":13614726,"url":"https://github.com/ubc/node-canvas-api","last_synced_at":"2025-04-05T00:05:01.855Z","repository":{"id":32562222,"uuid":"119436321","full_name":"ubc/node-canvas-api","owner":"ubc","description":"Access the Canvas API using Node.js. 54 functions (and counting)! Pull requests are welcome and appreciated.","archived":false,"fork":false,"pushed_at":"2024-10-30T22:59:47.000Z","size":1402,"stargazers_count":71,"open_issues_count":1,"forks_count":23,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-28T23:03:20.353Z","etag":null,"topics":["api","canvas","instructure","lms","node"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ubc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-29T20:20:00.000Z","updated_at":"2025-03-13T04:05:01.000Z","dependencies_parsed_at":"2023-07-16T01:02:35.552Z","dependency_job_id":"5dc52d20-461b-4ee7-a0b7-33e0575a1a67","html_url":"https://github.com/ubc/node-canvas-api","commit_stats":null,"previous_names":["ubccapico/node-canvas-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubc%2Fnode-canvas-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubc%2Fnode-canvas-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubc%2Fnode-canvas-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubc%2Fnode-canvas-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ubc","download_url":"https://codeload.github.com/ubc/node-canvas-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247266563,"owners_count":20910836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","canvas","instructure","lms","node"],"created_at":"2024-08-01T20:01:05.008Z","updated_at":"2025-04-05T00:05:01.836Z","avatar_url":"https://github.com/ubc.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"[![npm version](https://badge.fury.io/js/node-canvas-api.svg)](https://badge.fury.io/js/node-canvas-api)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)\n\n# Canvas LMS API for Node.js\nCanvas API functions bundled as a NPM package for Node.js. Note: this package no longer supports CJS as of [version 2.0.0](https://www.npmjs.com/package/node-canvas-api/v/2.0.0). If you need CJS support, please use [version 1.8.0](https://www.npmjs.com/package/node-canvas-api/v/1.8.0).\n\n## Getting Started\nThese instructions will get you a copy of the project up and running on your local machine for use with your own API tokens and Canvas domains.\n\n### Prerequisites\n\n1. **Install [Node LTS (20 or greater)](https://nodejs.org)**.\n\n### Installation\n\nTo use with NodeJS:\n```bash\n$ npm install node-canvas-api\n```\n\nRename the `sample.env` file to `.env` and add your institution's domain and API access token.\n\nAttached to the `canvasAPI` are a [bunch of functions](https://github.com/ubc/node-canvas-api/tree/master/src).\nRun the attached functions!\n\n### Example Usage\n\n#### Get information about self:\n```js\nimport { getSelf } from 'node-canvas-api'\n\ngetSelf().then(x =\u003e console.log(x))\n```\n\n#### Get students in a course:\n```js\nimport { getUsersInCourse, getOptions } from 'node-canvas-api'\n\ngetUsersInCourse(12345, getOptions.users.enrollmentType.student) // first argument is Canvas course ID\n  .then(students =\u003e console.log(students))\n```\n\n## Contribute\nContributions are welcome and greatly appreciated!\n\n### How to contribute\n1. Create an [issue](https://github.com/ubc/node-canvas-api/issues) describing what contribution you are planning to make.\n1. Fork the repo.\n1. Add your contributions.\n1. Once you're happy with your contribution, open an [pull request](https://github.com/ubc/node-canvas-api/pulls) and I'll take a look.\n\n## Usage\n* [Canvas Rubrics](https://github.com/ubc/canvas-rubric)\n* [Canvas Discussions](https://github.com/ubc/canvas-discussion)\n* [Canvas Syllabus](https://github.com/UBC-LFS/lfs-canvas-syllabus)\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubc%2Fnode-canvas-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fubc%2Fnode-canvas-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubc%2Fnode-canvas-api/lists"}