{"id":16161247,"url":"https://github.com/kennethwussmann/simplelogin-client","last_synced_at":"2026-01-20T07:32:14.451Z","repository":{"id":65826830,"uuid":"599338315","full_name":"KennethWussmann/simplelogin-client","owner":"KennethWussmann","description":"Zero-dependency TypeScript client for the SimpleLogin API","archived":false,"fork":false,"pushed_at":"2024-04-14T00:58:45.000Z","size":1972,"stargazers_count":1,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-14T15:23:39.189Z","etag":null,"topics":["api","browser","client","nodejs","rest","sdk","simplelogin","typescript"],"latest_commit_sha":null,"homepage":"https://kennethwussmann.github.io/simplelogin-client/","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/KennethWussmann.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}},"created_at":"2023-02-08T23:39:53.000Z","updated_at":"2024-05-12T22:29:16.729Z","dependencies_parsed_at":null,"dependency_job_id":"589990a8-917e-4ae9-8911-ac03816f78f5","html_url":"https://github.com/KennethWussmann/simplelogin-client","commit_stats":{"total_commits":67,"total_committers":1,"mean_commits":67.0,"dds":0.0,"last_synced_commit":"ee6fde980147ec388591eb98a48cfaa068f99d28"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KennethWussmann%2Fsimplelogin-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KennethWussmann%2Fsimplelogin-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KennethWussmann%2Fsimplelogin-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KennethWussmann%2Fsimplelogin-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KennethWussmann","download_url":"https://codeload.github.com/KennethWussmann/simplelogin-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247706448,"owners_count":20982604,"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":["api","browser","client","nodejs","rest","sdk","simplelogin","typescript"],"created_at":"2024-10-10T02:24:38.511Z","updated_at":"2026-01-20T07:32:14.442Z","avatar_url":"https://github.com/KennethWussmann.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e\u003ccode\u003esimplelogin-client\u003c/code\u003e\u003c/h1\u003e\n  \u003cp\u003e\n    \u003cstrong\u003eZero-dependency TypeScript client for the \u003ca href=\"https://simplelogin.io\"\u003eSimpleLogin.io\u003c/a\u003e API. Compatible with NodeJS and browsers.\u003c/strong\u003e\n  \u003c/p\u003e\n  \u003cp\u003e\n    \u003ca href=\"https://kennethwussmann.github.io/simplelogin-client/typedoc/index.html\"\u003eDocumentation\u003c/a\u003e • \u003ca href=\"https://kennethwussmann.github.io/simplelogin-client/redoc/index.html\"\u003eAPI Spec\u003c/a\u003e • \u003ca href=\"https://github.com/KennethWussmann/simplelogin-cli\"\u003eCLI Tool\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003e [!TIP]\n\u003e No time to code? Check out the [CLI tool](https://github.com/KennethWussmann/simplelogin-cli) based on this client SDK to get started quickly!\n\n## Features\n\n\u003e Interested in the state of the project? [Check the faq!](./docs/faq.md#whats-the-current-project-state)\n\n- [x] [Export](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/ImportExportApi.html)\n  - [x] [Export complete user data](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/ImportExportApi.html#exportUserData)\n  - [x] [Export aliases as CSV](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/ImportExportApi.html#exportAliasesAsCsv)\n- [x] [Account Management](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html)\n  - [x] [Login](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#login) ([+MFA](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#mfa)), [Register](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#registerAccount), [Activate](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#activateAccount), [Reactivate](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#reactivateAccount)\n  - [x] [Password reset](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#forgotPassword)\n  - [x] [User info](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#getUserInfo) and [statistics](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#getStats)\n  - [x] [API key management](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#createApiKey)\n  - [x] [Cookie token generation](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#getCookieToken)\n  - [x] [Logout](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#logout)\n  - [x] [Sudo mode](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#enableSudoMode)\n  - [x] [Account deletion](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AccountApi.html#deleteUser)\n- [x] [Alias Management](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html)\n  - [x] [Get alias options](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#getAliasOptions)\n  - [x] Create ([random](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#createRandomAlias) and [custom](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#createCustomAlias)), [Update](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#updateAlias), [Delete](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#deleteAlias)\n  - [x] [Contacts](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#getContacts) and [activities](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#getActivities)\n- [x] [Mailbox Management](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/MailboxApi.html)\n  - [x] [Get](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/MailboxApi.html#getMailboxes), [Create](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/MailboxApi.html#createMailbox), [Update](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/MailboxApi.html#updateMailbox), [Delete](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/MailboxApi.html#deleteMailbox)\n- [x] [Contact Management](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html)\n  - [x] [Get](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#getContacts), [Create](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#createContact)\n  - [x] [Delete](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#deleteContact)\n  - [x] [Block \u0026 unblock](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/AliasApi.html#toggleContactBlocking)\n- [x] [Settings](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/SettingsApi.html)\n  - [x] [Read](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/SettingsApi.html#getUserSettings) and [write settings](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/SettingsApi.html#updateUserSettings)\n  - [x] [Read random alias domains](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/SettingsApi.html#getAvailableDomainsForRandomAliases)\n- [x] [Custom Domain Management](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/CustomDomainApi.html)\n  - [x] [Get domains](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/CustomDomainApi.html#getCustomDomains)\n  - [x] [Update domain settings](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/CustomDomainApi.html#updateCustomDomain)\n  - [x] [View trash (deleted aliases)](https://kennethwussmann.github.io/simplelogin-client/typedoc/classes/CustomDomainApi.html#getDeletedAliases)\n- [ ] [Notifications](https://github.com/KennethWussmann/simplelogin-client/issues/9)\n  - [ ] Get notifications\n  - [ ] Mark notification as read\n- [ ] [Phone \u0026 Misc](https://github.com/KennethWussmann/simplelogin-client/issues/12)\n  - [ ] Phone reservation message retrieval\n  - [ ] Apple payment processing\n\n## Getting started\n\n`simplelogin-client` works in most NodeJS versions and browsers, but may require a tweak when not used with NodeJS 18 or in outdated browsers. Check the [compatibility guide](./docs/faq.md#what-nodejs-version-and-browsers-are-supported).\n\nTo start using this API client in your JS/TS projects:\n\n```shell\n# Install dependency\nnpm install --save simplelogin-client\n```\n\n```typescript\nimport { SimpleLoginClient } from 'simplelogin-client';\n\nconst { alias } = new SimpleLoginClient({\n  apiKey: process.env.API_KEY,\n})\n\nconst createdAlias = await alias.createRandomAlias({\n  note: 'This alias was created with simplelogin-client!',\n});\n\nconsole.log(createdAlias);\n/* Output:\n{\n  id: 50001,\n  creation_date: '2023-02-10 20:19:37+00:00',\n  alias: 'nederlanden_heatherington@example.com',\n  mailbox: { email: 'somewhere@gmail.com', id: 50001 },\n  enabled: true,\n  pinned: false,\n  note: \"This alias was created with simplelogin-client!\",\n  ...\n}\n*/\n```\n\nCheck the [documentation](https://kennethwussmann.github.io/simplelogin-client/typedoc/index.html) for all available methods and the [FAQ](./docs/faq.md) in case of questions.\n\n\u003e :bangbang: Please don't contact the SimpleLogin team with issues regarding this client. Instead open an issue in this repository.\n\n## Development\n\nWant to contribute fixes to the API client or spec? Check the [development guide](./docs/development.md)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkennethwussmann%2Fsimplelogin-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkennethwussmann%2Fsimplelogin-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkennethwussmann%2Fsimplelogin-client/lists"}