{"id":20758484,"url":"https://github.com/darkpurple141/github-api-query","last_synced_at":"2026-04-18T07:33:01.406Z","repository":{"id":57360196,"uuid":"114196889","full_name":"DarkPurple141/github-api-query","owner":"DarkPurple141","description":"A wrapper for the github api to ease requesting files, directory information from a repository","archived":false,"fork":false,"pushed_at":"2018-06-04T10:01:47.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-27T01:49:28.696Z","etag":null,"topics":["api","api-client","axios","github","npm","wrapper"],"latest_commit_sha":null,"homepage":null,"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/DarkPurple141.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}},"created_at":"2017-12-14T03:17:29.000Z","updated_at":"2018-06-04T10:01:48.000Z","dependencies_parsed_at":"2022-09-06T21:41:13.840Z","dependency_job_id":null,"html_url":"https://github.com/DarkPurple141/github-api-query","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DarkPurple141/github-api-query","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkPurple141%2Fgithub-api-query","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkPurple141%2Fgithub-api-query/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkPurple141%2Fgithub-api-query/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkPurple141%2Fgithub-api-query/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DarkPurple141","download_url":"https://codeload.github.com/DarkPurple141/github-api-query/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkPurple141%2Fgithub-api-query/sbom","scorecard":{"id":37404,"data":{"date":"2025-08-11","repo":{"name":"github.com/DarkPurple141/github-api-query","commit":"25c574d5f091fc9e911a4a5671a3e4189bc641c6"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"55 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-42xw-2xvc-qx8m","Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-14T20:38:23.830Z","repository_id":57360196,"created_at":"2025-08-14T20:38:23.831Z","updated_at":"2025-08-14T20:38:23.831Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277088732,"owners_count":25758763,"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","status":"online","status_checked_at":"2025-09-26T02:00:09.010Z","response_time":78,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","api-client","axios","github","npm","wrapper"],"created_at":"2024-11-17T09:51:35.438Z","updated_at":"2025-09-26T13:54:25.822Z","avatar_url":"https://github.com/DarkPurple141.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"simple-github-api\n====\n\n[![npm version](https://img.shields.io/npm/v/simple-github-api.svg?style=flat-square)](https://www.npmjs.org/package/simple-github-api)\n[![Build Status](https://travis-ci.org/DarkPurple141/github-api-query.svg?branch=master)](https://travis-ci.org/DarkPurple141/github-api-query)\n[![Coverage Status](https://coveralls.io/repos/github/DarkPurple141/github-api-query/badge.svg?branch=master)](https://coveralls.io/github/DarkPurple141/github-api-query?branch=master)\n\nThis is a simple wrapper for the\n[GitHub API](https://developer.github.com/v3/) to ease requesting files,\n directory information from a repository.\n\n### Basic Usage:\n```bash\n# To download and install\nnpm install --save simple-github-api\n```\n\n```js\nconst API = require('simple-github-api')\n\nlet instance = new API({\n   // https://github.com/blog/1509-personal-api-tokens\n   token: \"Some valid OAUTH key issued by github\",\n\n   // choose your repo, or you can omit this option and set it later\n   repo: \"myProject\",\n\n   // the username/owner of the repo(s)\n   username: \"markzuckerberg\"\n})\n\ninstance.get('/some/path')\n   .then(metafile =\u003e {\n      // returns a file object or if\n      // a directory a list of file objects\n      console.log(metafile)\n   })\n   .catch(err =\u003e {\n      throw err\n   })\n\n// OR\n\ninstance.getContents('some/file/path')\n   .then(file =\u003e {\n      // contains actual file\n      console.log(file)\n   })\n\n```\n\n### API\n\n```js\nconst API = require('simple-github-api')\n```\n\n#### Constructors\nThe `new` keyword is required to\ncreate an instance of the API\nobject.\n\nIt is recommended to get an `OAUTH`\nkey issued for your application and\ninstantiate with that token.\n\n```js\nlet instance = new API(\n   {\n      token: \"A valid token\"\n   })\n```\n\nThe default object however doesn't require any config.\n```js\n// results in a warning.\n// If you do \u003e 60 requests per day\n// you will get a 401 error for api requests.\nlet instance = new API()\n```\nYou can also pass in basic auth credentials, and a repository.\n\n```js\n// all valid options you can pass in\noptions = {\n   username: \"jeff\",\n   pw: \"secret\",\n   repo: \"sweetProject\",\n\n   // token will override basic auth if provided\n   token: \"OAUTHToken\"\n}\n```\n#### Main Features\nThe basic interface below is unlikely to change, although further features may be added later. For all of the below path is a string.\n\nInterface | Description\n--------- | ----------\n`.get(path)`         | Returns the fileObject or directory for the relevant file. Takes a string relative path, and requires the `repo` and `user` to be set.\n`.getUrl(path)`      | Returns the current url formed for the request. Mainly called internally.\n`.getFileContents(path)` | Returns the `file` contents directly, decoded and ready to use.\n`.listRepos()`  | List repositories of current user\n`.getRepo(repo, user(optional))`  | Provides the repo object for a nominated repository. User defaults to current.\n`.decode(encodedFile)`  | Decodes a file object in base64Unicode.\n\n\n\n#### Configuration\n```js\n// sets/update a new repo\ninstance.repo = \"NewRepo\"\n\n// sets/update user\ninstance.user = \"newUser\"\n\n// returns the underlying axios instance\n// which you can configure as you so desire\n// More on axios here https://github.com/axios/axios\nlet axios = instance.axios\n```\n\n## Credits\nProject built leaning heavily on the simplicity of the axios api.\n\n## License\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkpurple141%2Fgithub-api-query","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarkpurple141%2Fgithub-api-query","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkpurple141%2Fgithub-api-query/lists"}