{"id":20505601,"url":"https://github.com/openbankproject/obp-typescript","last_synced_at":"2025-07-29T00:09:02.102Z","repository":{"id":144891439,"uuid":"611264000","full_name":"OpenBankProject/OBP-TypeScript","owner":"OpenBankProject","description":"A TypeScript SDK for OBP (Javascript developers might be interested in this)","archived":false,"fork":false,"pushed_at":"2024-10-16T08:16:15.000Z","size":339,"stargazers_count":2,"open_issues_count":4,"forks_count":2,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-07-02T08:10:37.851Z","etag":null,"topics":[],"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/OpenBankProject.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-03-08T13:20:17.000Z","updated_at":"2024-05-28T06:04:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"96b72a83-abb1-465c-8f17-07e98d0701e8","html_url":"https://github.com/OpenBankProject/OBP-TypeScript","commit_stats":{"total_commits":25,"total_committers":3,"mean_commits":8.333333333333334,"dds":0.12,"last_synced_commit":"11284ae6406153929647a96de7b0592cdb6a5944"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/OpenBankProject/OBP-TypeScript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-TypeScript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-TypeScript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-TypeScript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-TypeScript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenBankProject","download_url":"https://codeload.github.com/OpenBankProject/OBP-TypeScript/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-TypeScript/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267606631,"owners_count":24114765,"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-28T02:00:09.689Z","response_time":68,"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":[],"created_at":"2024-11-15T19:48:18.560Z","updated_at":"2025-07-29T00:09:02.080Z","avatar_url":"https://github.com/OpenBankProject.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OBP-TypeScript\n\n#### Install\n\n##### yarn\n\n```\n  yarn add obp-typescript\n```\n\n##### npm\n\n```\n  npm install obp-typescript\n```\n\n#### Example\n\n```typescript\nimport {\n  API,\n  APIClientConfig,\n  DirectLoginAuthentication,\n  Version,\n  get,\n  create,\n  Bank,\n  Account,\n  Transaction,\n  GetTransactionsForAccountFull,\n  TransactionRequestAccountBody,\n  CreateTransactionRequestAccount,\n} from \"obp-typescript\";\n\n(async () =\u003e {\n  const directLogin: DirectLoginAuthentication = {\n    username: process.env.OBP_USERNAME || \"\",\n    password: process.env.OBP_PASSWORD || \"\",\n    consumerKey: process.env.OBP_CONSUMER_KEY || \"\",\n  };\n  const clientConfig: APIClientConfig = {\n    baseUri: \"https://apisandbox.openbankproject.com\",\n    version: Version.v500,\n    authentication: directLogin,\n  };\n  const banks = await get\u003cAPI.Bank\u003e(clientConfig, Bank);\n  const account = await get\u003cAPI.Account\u003e(clientConfig, Account);\n\n  const transactionFn = get\u003cAPI.Transaction\u003e(clientConfig, Transaction);\n  // Get transaction for account full.\n  const transactionsForAccountFull = await transactionFn(\n    GetTransactionsForAccountFull\n  )(\"bankId\", \"accountId\", \"viewId\");\n\n  // New transaction body.\n  const body: TransactionRequestAccountBody = {\n    description: \"Dummy transaction full data\",\n    to: {\n      bank_id: \"bankId\",\n      account_id: \"accountId\",\n    },\n    value: {\n      currency: \"EUR\",\n      amount: 1.0,\n    },\n  };\n  // Create transaction request account.\n  await create\u003cAPI.Transaction\u003e(\n    clientConfig,\n    Transaction\n  )(CreateTransactionRequestAccount)(\n    \"bankId\",\n    \"accountId\",\n    \"viewId\"\n  )(body);\n})();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbankproject%2Fobp-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenbankproject%2Fobp-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbankproject%2Fobp-typescript/lists"}