{"id":22096530,"url":"https://github.com/uphold/uphold-sdk-javascript","last_synced_at":"2025-07-24T22:32:10.705Z","repository":{"id":21047179,"uuid":"91679457","full_name":"uphold/uphold-sdk-javascript","owner":"uphold","description":"Uphold SDK for JavaScript","archived":false,"fork":false,"pushed_at":"2024-02-09T14:53:04.000Z","size":1874,"stargazers_count":87,"open_issues_count":15,"forks_count":22,"subscribers_count":63,"default_branch":"master","last_synced_at":"2025-07-08T20:51:08.338Z","etag":null,"topics":["browser","javascript","nodejs","sdk","uphold"],"latest_commit_sha":null,"homepage":"https://uphold.github.io/uphold-sdk-javascript","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/uphold.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","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":"2017-05-18T10:14:57.000Z","updated_at":"2025-05-02T16:30:19.000Z","dependencies_parsed_at":"2024-06-18T21:19:11.808Z","dependency_job_id":"007a2b1d-edb2-4bce-88ba-e688d4e7cc84","html_url":"https://github.com/uphold/uphold-sdk-javascript","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/uphold/uphold-sdk-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fuphold-sdk-javascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fuphold-sdk-javascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fuphold-sdk-javascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fuphold-sdk-javascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uphold","download_url":"https://codeload.github.com/uphold/uphold-sdk-javascript/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uphold%2Fuphold-sdk-javascript/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266913680,"owners_count":24005579,"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-07-24T02:00:09.469Z","response_time":99,"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":["browser","javascript","nodejs","sdk","uphold"],"created_at":"2024-12-01T04:11:30.758Z","updated_at":"2025-07-24T22:32:10.364Z","avatar_url":"https://github.com/uphold.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/uphold/uphold-sdk-javascript\"\u003e\n    \u003cimg src=\"docs/images/favicon.ico\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eUphold SDK for JavaScript\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://travis-ci.org/uphold/uphold-sdk-javascript\"\u003e\n    \u003cimg src=\"https://img.shields.io/travis/uphold/uphold-sdk-javascript/master.svg?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"/dist/browser/uphold-sdk-javascript.js\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/size/uphold/uphold-sdk-javascript/dist/browser/uphold-sdk-javascript.js?style=flat-square\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@uphold/uphold-sdk-javascript\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/@uphold/uphold-sdk-javascript.svg?style=flat-square\"/\u003e\n  \u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/badge/node-%3E=4-brightgreen.svg?style=flat-square\"/\u003e\n  \u003cimg src=\"https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square\"/\u003e\n  \u003ca href=\"https://github.com/uphold/uphold-sdk-javascript/blob/master/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/@uphold/uphold-sdk-javascript.svg?style=flat-square\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nThis SDK is built on top of the [Uphold API](https://uphold.com/en/developer/api) and it's designed to help developers integrate Uphold services into their applications, by making it easier for them to interact with the API in a clean and controlled manner.\n\nIt provides developers the facilities to handle authentication, requests, pagination and error handling.\n\n## Documentation\n\nPlease consult the [documentation website](https://uphold.github.io/uphold-sdk-javascript) for a more detailed specification of the SDK and its modules:\n\n- [SDK](https://uphold.github.io/uphold-sdk-javascript/sdk.html)\n- [Client](https://uphold.github.io/uphold-sdk-javascript/client.html)\n- [Storage](https://uphold.github.io/uphold-sdk-javascript/storage.html)\n- [Paginator](https://uphold.github.io/uphold-sdk-javascript/paginator.html)\n- [OAuthClient](https://uphold.github.io/uphold-sdk-javascript/oauthclient.html)\n- [Errors](https://uphold.github.io/uphold-sdk-javascript/errors.html)\n- [Actions](https://uphold.github.io/uphold-sdk-javascript/actions.html)\n\n## Supported platforms\n\nThis SDK can be used on both **browser** and **Node.js** environments.\n\nThere are no major dependencies other than the fact that it uses the [Fetch API](https://developer.mozilla.org/en/docs/Web/API/Fetch_API) to perform network requests, which [some browsers do not yet support](http://caniuse.com/#feat=fetch).\n\nHowever, you can easily cover your bases by adding a [polyfill](https://github.com/github/fetch). If this is a solution you are not comfortable with then please consult the [Client](https://uphold.github.io/uphold-sdk-javascript/client.html) documentation and follow the instructions on how to override it.\n\n## Usage\n\nIn this section we feature a simple usage example:\n\n```js\nimport SDK from '@uphold/uphold-sdk-javascript';\n\nconst sdk = new SDK({\n  clientId: 'foo',\n  clientSecret: 'bar'\n});\n\nsdk.authorize('code')\n  .then(() =\u003e sdk.getMe())\n  .then(user =\u003e {\n    console.log(user);\n  });\n```\n\n### Options\n\nBelow you can consult the list of available options you can pass to the SDK [constructor](https://uphold.github.io/uphold-sdk-javascript/sdk.html#constructor):\n\n| Key               | Required | Default                  | Description                           |\n|:------------------|:---------|:-------------------------|:--------------------------------------|\n| `accessTokenKey`  | No       | `uphold.access_token`    | Key used to store the `access_token`  |\n| `baseUrl`         | No       | `https://api.uphold.com` | Uphold API's url                      |\n| `clientId`        | Yes      |                          | Your client id                        |\n| `clientSecret`    | Yes      |                          | Your client secret                    |\n| `itemsPerPage`    | No       | `10`                     | Pagination size                       |\n| `refreshTokenKey` | No       | `uphold.refresh_token`   | Key used to store the `refresh_token` |\n| `version`         | No       | `v0`                     | Uphold API's version                  |\n\n## Installation\n\nTo install the SDK just type into your terminal:\n\n```sh\n$ npm install @uphold/uphold-sdk-javascript\n```\n\nOr, if you're using `yarn`:\n\n```sh\n$ yarn add @uphold/uphold-sdk-javascript\n```\n\n## Feedback, bugs \u0026 contributions\n\n**Contributions** are welcome, consult the [guidelines for contributing](/.github/CONTRIBUTING.md) for instructions.\n\n## License\n\n[MIT](/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuphold%2Fuphold-sdk-javascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuphold%2Fuphold-sdk-javascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuphold%2Fuphold-sdk-javascript/lists"}