{"id":21850503,"url":"https://github.com/circlefin/circle-nodejs-sdk","last_synced_at":"2025-04-06T00:09:29.339Z","repository":{"id":59997317,"uuid":"521340594","full_name":"circlefin/circle-nodejs-sdk","owner":"circlefin","description":"Node.js SDK for Circle API","archived":false,"fork":false,"pushed_at":"2025-01-09T16:16:35.000Z","size":1539,"stargazers_count":29,"open_issues_count":5,"forks_count":19,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-29T23:08:46.507Z","etag":null,"topics":["nodejs","sdk"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/circlefin.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-04T16:35:02.000Z","updated_at":"2025-03-26T22:47:05.000Z","dependencies_parsed_at":"2025-01-01T08:11:19.193Z","dependency_job_id":"4de12c90-f338-48fe-b3a9-63cb2a4852f6","html_url":"https://github.com/circlefin/circle-nodejs-sdk","commit_stats":{"total_commits":53,"total_committers":8,"mean_commits":6.625,"dds":0.5660377358490566,"last_synced_commit":"48a37a7e2bd9812c61f6b91f03f18f8111b3d87d"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circlefin%2Fcircle-nodejs-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circlefin%2Fcircle-nodejs-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circlefin%2Fcircle-nodejs-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circlefin%2Fcircle-nodejs-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/circlefin","download_url":"https://codeload.github.com/circlefin/circle-nodejs-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415967,"owners_count":20935387,"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":["nodejs","sdk"],"created_at":"2024-11-28T00:17:50.487Z","updated_at":"2025-04-06T00:09:29.322Z","avatar_url":"https://github.com/circlefin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Circle APIs Node.js Library\n\n[![npm version](https://img.shields.io/npm/v/@circle-fin/circle-sdk)](https://www.npmjs.com/package/@circle-fin/circle-sdk)\n[![npm downloads](https://img.shields.io/npm/dm/@circle-fin/circle-sdk)](https://www.npmjs.com/package/@circle-fin/circle-sdk)\n\n\nThe Circle Node library provides convenient access to the Circle API for\napplications written in server-side JavaScript. For the API reference, see the [Circle API docs](https://developers.circle.com/reference).\n\n## Requirements\n\nNode 10 or higher.\n\n## Installation\n\nInstall the package with:\n\n```sh\nnpm install @circle-fin/circle-sdk --save\n# or\nyarn add @circle-fin/circle-sdk\n```\n\n## Usage\n\nIn order to make API calls, you will need an API key. Once you obtain one, you can use this SDK to make API calls as follows:\n\n```Typescript\nimport { Circle, CircleEnvironments, SubscriptionRequest } from \"@circle-fin/circle-sdk\";\n\n// Initialize API driver\nconst circle = new Circle(\n    '\u003cyour-api-key\u003e',\n    CircleEnvironments.sandbox      // API base url\n);\n\nasync function createSubscription() {\n    const subscribeReq: SubscriptionRequest = {\n        endpoint: \"https://example.org/handler/for/notifications\"\n    };\n\n    const subscribeResp = await circle.subscriptions.createSubscription(subscribeReq);\n    console.log(subscribeResp.data);\n}\ncreateSubscription();\n```\n\n## Development\nClone this repo and install dependencies using \n```sh\nyarn install\n```\n\n1. Run the codegen command to generate the source code for this SDK from the `sdk.json` OpenAPI specification file:\n\n    ```sh\n    yarn gen-sdk\n    ```\n\n2. Run all tests:\n\n    ```bash\n    yarn test\n    ```\n\n\n## Contributions\n\nPlease follow the [Conventional Commits][convencomms] format for all commits when creating a contributing pull request for this repo. \n\n[convencomms]: https://www.conventionalcommits.org/en/v1.0.0/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirclefin%2Fcircle-nodejs-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcirclefin%2Fcircle-nodejs-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirclefin%2Fcircle-nodejs-sdk/lists"}