{"id":18017760,"url":"https://github.com/assafmo/ordernetapi","last_synced_at":"2025-10-08T20:36:02.370Z","repository":{"id":45005406,"uuid":"257936228","full_name":"assafmo/OrdernetAPI","owner":"assafmo","description":"Query spark{nesua,meitav,psagot}.ordernet.co.il","archived":false,"fork":false,"pushed_at":"2022-01-14T11:18:31.000Z","size":184,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-02T05:54:12.741Z","etag":null,"topics":["cli","command-line","command-line-tool","stock-data","stock-market"],"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/assafmo.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":"2020-04-22T15:06:42.000Z","updated_at":"2024-11-30T11:05:06.000Z","dependencies_parsed_at":"2022-09-26T17:21:00.967Z","dependency_job_id":null,"html_url":"https://github.com/assafmo/OrdernetAPI","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/assafmo/OrdernetAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assafmo%2FOrdernetAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assafmo%2FOrdernetAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assafmo%2FOrdernetAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assafmo%2FOrdernetAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/assafmo","download_url":"https://codeload.github.com/assafmo/OrdernetAPI/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assafmo%2FOrdernetAPI/sbom","scorecard":{"id":212975,"data":{"date":"2025-08-11","repo":{"name":"github.com/assafmo/OrdernetAPI","commit":"460100886842f5b7b649f7fb507bd1830f4ffb3f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/16 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":"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":"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":"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":"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":"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":"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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 14 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"15 existing vulnerabilities detected","details":["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-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-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-mxhp-79qh-mcx6","Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq"],"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-17T01:05:46.517Z","repository_id":45005406,"created_at":"2025-08-17T01:05:46.517Z","updated_at":"2025-08-17T01:05:46.517Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000640,"owners_count":26082818,"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-10-08T02:00:06.501Z","response_time":56,"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":["cli","command-line","command-line-tool","stock-data","stock-market"],"created_at":"2024-10-30T04:24:15.746Z","updated_at":"2025-10-08T20:36:02.340Z","avatar_url":"https://github.com/assafmo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OrdernetAPI\n\nA simple tool for querying `https://spark{nesua,meitav,psagot}.ordernet.co.il/api`.  \nRight now only returns total balance for each account.\n\n[![npm version](https://badge.fury.io/js/ordernet-api.svg)](https://badge.fury.io/js/ordernet-api)\n\n# CLI\n\n```bash\nnpm install -g ordernet-api\n```\n\n## Options\n\n```console\n$ ordernet-api -h\nOptions:\n  -u, --user, --username  Username for login into Spark.     [string] [required]\n  -p, --pass, --password  Password for login into Spark.     [string] [required]\n  -b, --broker            Broker name.\n                      [string] [required] [choices: \"nesua\", \"meitav\", \"psagot\"]\n  -a, --account-key       Print balance only for these account keys. This is\n                          usually much faster. An account key has the form\n                          \"ACC_XXX-YYYYYY\". You can find it out using the\n                          --verbose flag.                                [array]\n  -v, --verbose           Print log messages                           [boolean]\n  -h, --help              Show help                                    [boolean]\n  -V, --version           Show version number                          [boolean]\n\nExamples:\n  cli.js -u 1234 -p abcd -b nesua           Print the balance for each account\n                                            associated with this Spark user.\n  cli.js -u 1234 -p abcd -a ACC_000-111111  Print the balance only for the\n  -b nesua                                  account key ACC_000-111111.\n  cli.js -u 1234 -p abcd -a ACC_000-111111  Print the balance only for the\n  -a ACC_000-222222 -b nesua                account keys ACC_000-111111 and\n                                            ACC_000-222222.\n\nFor more info visit https://github.com/assafmo/OrdernetAPI\n```\n\n# Library API\n\n```bash\nnpm install ordernet-api\n```\n\nor\n\n```bash\nyarn add ordernet-api\n```\n\n## Constants\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#config\"\u003econfig\u003c/a\u003e : \u003ccode\u003e\u003ca href=\"#Config\"\u003eConfig\u003c/a\u003e\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eThe internal config object.\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\n## Functions\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#authenticate\"\u003eauthenticate(username, password, broker)\u003c/a\u003e ⇒ \u003ccode\u003eVoid\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eAuthenticate against the Spark system of the broker. This function must be called first as it initializes the \u003ccode\u003eapiUrl\u003c/code\u003e and \u003ccode\u003eauthorization\u003c/code\u003e fields in the internal config. That way we won\u0026#39;t need to authenticate again for each API call. Uses \u003ccode\u003e/api/Auth/Authenticate\u003c/code\u003e.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#getAccounts\"\u003egetAccounts()\u003c/a\u003e ⇒ \u003ccode\u003e\u003ca href=\"#Account\"\u003eArray.\u0026lt;Account\u0026gt;\u003c/a\u003e\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eGet all the accounts listed under this Spark user. Uses \u003ccode\u003e/api/DataProvider/GetStaticData\u003c/code\u003e.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#getAccountBalance\"\u003egetAccountBalance(account)\u003c/a\u003e ⇒ \u003ccode\u003enumber\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eGet total balance of an account. Uses \u003ccode\u003e/api/Account/GetAccountSecurities\u003c/code\u003e.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#accountKeyToNumber\"\u003eaccountKeyToNumber(key)\u003c/a\u003e ⇒ \u003ccode\u003estring\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eConvert account key to account number.\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\n## Typedefs\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#Config\"\u003eConfig\u003c/a\u003e : \u003ccode\u003eObject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#Account\"\u003eAccount\u003c/a\u003e : \u003ccode\u003eObject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003c/dl\u003e\n\n\u003ca name=\"config\"\u003e\u003c/a\u003e\n\n## config : [\u003ccode\u003eConfig\u003c/code\u003e](#Config)\n\nThe internal config object.\n\n**Kind**: global constant  \n\u003ca name=\"authenticate\"\u003e\u003c/a\u003e\n\n## authenticate(username, password, broker) ⇒ \u003ccode\u003eVoid\u003c/code\u003e\n\nAuthenticate against the Spark system of the broker. This function must be called first as it initializes the `apiUrl` and `authorization` fields in the internal config. That way we won't need to authenticate again for each API call. Uses `/api/Auth/Authenticate`.\n\n**Kind**: global function\n\n| Param    | Type                | Description                                                                                                      |\n| -------- | ------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| username | \u003ccode\u003estring\u003c/code\u003e | The Spark username                                                                                               |\n| password | \u003ccode\u003estring\u003c/code\u003e | The Spark password                                                                                               |\n| broker   | \u003ccode\u003estring\u003c/code\u003e | Used to get the API URL like this: `https://spark${broker}.ordernet.co.il/api`. E.g. `nesua`, `meitav`, `psagot` |\n\n\u003ca name=\"getAccounts\"\u003e\u003c/a\u003e\n\n## getAccounts() ⇒ [\u003ccode\u003eArray.\u0026lt;Account\u0026gt;\u003c/code\u003e](#Account)\n\nGet all the accounts listed under this Spark user. Uses `/api/DataProvider/GetStaticData`.\n\n**Kind**: global function  \n**Returns**: [\u003ccode\u003eArray.\u0026lt;Account\u0026gt;\u003c/code\u003e](#Account) - - All accounts listed under this Spark user  \n\u003ca name=\"getAccountBalance\"\u003e\u003c/a\u003e\n\n## getAccountBalance(account) ⇒ \u003ccode\u003enumber\u003c/code\u003e\n\nGet total balance of an account. Uses `/api/Account/GetAccountSecurities`.\n\n**Kind**: global function  \n**Returns**: \u003ccode\u003enumber\u003c/code\u003e - - Total balance of the account\n\n| Param   | Type                             | Description                |\n| ------- | -------------------------------- | -------------------------- |\n| account | [\u003ccode\u003eAccount\u003c/code\u003e](#Account) | Account to get balance for |\n\n\u003ca name=\"accountKeyToNumber\"\u003e\u003c/a\u003e\n\n## accountKeyToNumber(key) ⇒ \u003ccode\u003estring\u003c/code\u003e\n\nConvert account key to account number.\n\n**Kind**: global function  \n**Returns**: \u003ccode\u003estring\u003c/code\u003e - - The account number\n\n| Param | Type                | Description                                      |\n| ----- | ------------------- | ------------------------------------------------ |\n| key   | \u003ccode\u003estring\u003c/code\u003e | The account key for API usage (`ACC_XXX-YYYYYY`) |\n\n\u003ca name=\"Config\"\u003e\u003c/a\u003e\n\n## Config : \u003ccode\u003eObject\u003c/code\u003e\n\n**Kind**: global typedef  \n**Properties**\n\n| Name          | Type                | Description                                                                                                                                                                     |\n| ------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| apiUrl        | \u003ccode\u003estring\u003c/code\u003e | The API URL to send requests to. Probably one of `https://sparknesua.ordernet.co.il/api`, `https://sparkmeitav.ordernet.co.il/api` or `https://sparkpsagot.ordernet.co.il/api`. |\n| authorization | \u003ccode\u003estring\u003c/code\u003e | The bearer token to pass for authentication in each API call                                                                                                                    |\n\n\u003ca name=\"Account\"\u003e\u003c/a\u003e\n\n## Account : \u003ccode\u003eObject\u003c/code\u003e\n\n**Kind**: global typedef  \n**Properties**\n\n| Name   | Type                | Description                                      |\n| ------ | ------------------- | ------------------------------------------------ |\n| key    | \u003ccode\u003estring\u003c/code\u003e | The account key for API usage (`ACC_XXX-YYYYYY`) |\n| name   | \u003ccode\u003estring\u003c/code\u003e | The name listed on the account                   |\n| number | \u003ccode\u003enumber\u003c/code\u003e | The account number (`YYYYYY`)                    |\n\n# Refs\n\n- https://github.com/danielbraun/ordernet-scraper\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassafmo%2Fordernetapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fassafmo%2Fordernetapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassafmo%2Fordernetapi/lists"}