{"id":43589330,"url":"https://github.com/xivapi/xivapi-js","last_synced_at":"2026-02-04T01:49:06.083Z","repository":{"id":34049095,"uuid":"164463726","full_name":"xivapi/xivapi-js","owner":"xivapi","description":"Node.js wrapper for XIVAPI","archived":false,"fork":false,"pushed_at":"2025-12-02T19:52:24.000Z","size":190,"stargazers_count":80,"open_issues_count":0,"forks_count":14,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-01-13T03:26:55.347Z","etag":null,"topics":["ffxiv","xivapi"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/xivapi.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-01-07T16:58:52.000Z","updated_at":"2025-12-02T19:52:24.000Z","dependencies_parsed_at":"2024-06-21T02:14:14.207Z","dependency_job_id":"9cdec152-1aa0-4991-9e40-a948a99d73a5","html_url":"https://github.com/xivapi/xivapi-js","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/xivapi/xivapi-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fxivapi-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fxivapi-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fxivapi-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fxivapi-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xivapi","download_url":"https://codeload.github.com/xivapi/xivapi-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fxivapi-js/sbom","scorecard":{"id":1239931,"data":{"date":"2025-11-10","repo":{"name":"github.com/xivapi/xivapi-js","commit":"f29a67a128eba6c0a3450057912fb64b61d1302d"},"scorecard":{"version":"v5.3.1-0.20251106164954-c65a663bf4a9","commit":"c65a663bf4a93c0f6eca32e6d34713d3e3440e11"},"score":5.9,"checks":[{"name":"Maintained","score":10,"reason":"25 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#maintained"}},{"name":"Code-Review","score":3,"reason":"Found 4/13 approved changesets -- score normalized to 3","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/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#dangerous-workflow"}},{"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/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/npm-publish.yml:10","Warn: no topLevel permission defined: .github/workflows/npm-publish.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#token-permissions"}},{"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/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#binary-artifacts"}},{"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/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#security-policy"}},{"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/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/xivapi/xivapi-js/npm-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/xivapi/xivapi-js/npm-publish.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/npm-publish.yml:7"],"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/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#packaging"}},{"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/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#signed-releases"}},{"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/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 21 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: https://osv.dev/GHSA-mh29-5h37-fv8m"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c65a663bf4a93c0f6eca32e6d34713d3e3440e11/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-11-21T11:25:51.480Z","repository_id":34049095,"created_at":"2025-11-21T11:25:51.480Z","updated_at":"2025-11-21T11:25:51.480Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29064007,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-04T00:26:14.114Z","status":"ssl_error","status_checked_at":"2026-02-04T00:23:06.435Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["ffxiv","xivapi"],"created_at":"2026-02-04T01:49:02.744Z","updated_at":"2026-02-04T01:49:06.069Z","avatar_url":"https://github.com/xivapi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xivapi-js\n\n[![npm version](https://badge.fury.io/js/%40xivapi%2Fjs.svg)](https://badge.fury.io/js/%40xivapi%2Fjs)\n[![license](https://img.shields.io/github/license/xivapi/xivapi-js.svg)](LICENSE)\n\nA JavaScript library for working with [XIVAPI v2](https://v2.xivapi.com/), providing a source of Final Fantasy XIV game data. It lets you fetch, search, and use FFXIV data easily in a promise-based manner.\n\n\u003e [!WARNING]\n\u003e `@xivapi/js@0.4.5` (using XIVAPI v1) is now deprecated. Please use it at your own risk. We strongly recommend you update to the latest version. Migration guide and details: https://v2.xivapi.com/docs/migrate/.\n\nIf you need help or run into any issues, please [open an issue](https://github.com/xivapi/xivapi-js/issues) on GitHub or join the [XIVAPI Discord server](https://discord.gg/MFFVHWC) for support.\n\n## Installation\n\n```bash\nnpm install @xivapi/js@latest    # or use yarn, pnpm, or bun\n```\n\n## Usage Examples\n\n#### 1. Importing and Initialization\n\n```js\nimport xivapi from '@xivapi/js';\n\n// Basic instance\nconst xiv = new xivapi();\n\n// With options\nconst xivCustom = new xivapi({\n  version: \"7.0\",    // specify game version\n  language: \"ja\",    // specify language (ja, en, de, fr)\n  verbose: true      // output more logging\n});\n```\n\n#### 2. Get an Item\n\n```js\n// Fetch the Gil item (item ID 1)\nconst item = await xiv.items.get(1);\n\nconsole.log(item.fields.Name); // \"Gil\" (or equivalent in your language)\n```\n\n#### 3. Search Example\n\n```js\n// Find all items named \"gil\"\nconst params = {\n  query: 'Name~\"gil\"',\n  sheets: \"Item\"\n};\n\nconst { results } = await xiv.search(params);\nconsole.log(results[0]);\n\n/*\nOutput example:\n{\n  \"score\": 1,\n  \"sheet\": \"Item\",\n  \"row_id\": 1,\n  \"fields\": {\n    \"Icon\": {\n      \"id\": 65002,\n      \"path\": \"ui/icon/065000/065002.tex\",\n      \"path_hr1\": \"ui/icon/065000/065002_hr1.tex\"\n    },\n    \"Name\": \"Gil\",\n    \"Singular\": \"gil\"\n  }\n}\n*/\n```\n\n#### 4. Using Raw XIVAPI v2 Endpoints\n\n```js\n// Fetch a raw asset file (e.g. icon image)\nconst assets = await xiv.data.assets();\nconst asset = await assets.get({\n  path: \"ui/icon/051000/051474_hr1.tex\",\n  format: \"png\" // jpg or webp also supported\n});\n\n// List all quests\nconst sheets = await xiv.data.sheets();\nconst quests = await sheets.list(\"Quest\");\nconsole.log(quests);\n\n// List available game versions\nconst versions = await xiv.data.versions();\nconsole.log(versions[0]); // e.g. \"7.0\"\n```\n\n## Contributing\n\nWe welcome all contributions! Whether you'd like to report a bug, suggest a feature, improve the documentation, or submit a pull request, your help is appreciated.\n\nTo get started, clone the repository with: `git clone https://github.com/xivapi/xivapi-js.git`\n\nBefore opening a pull request, please:\n- Make sure your code passes linting and all current tests (`npm run lint \u0026\u0026 npm test`).\n- Clearly explain your changes and reference any relevant issues in your PR description.\n\nIf you have questions, suggestions, or want to discuss changes before contributing, feel free to open an issue!\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxivapi%2Fxivapi-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxivapi%2Fxivapi-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxivapi%2Fxivapi-js/lists"}