{"id":18542724,"url":"https://github.com/coinbase/coinbase-cloud-sdk-js","last_synced_at":"2025-04-09T18:32:04.610Z","repository":{"id":63590060,"uuid":"563113001","full_name":"coinbase/coinbase-cloud-sdk-js","owner":"coinbase","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-07T08:01:07.000Z","size":180,"stargazers_count":18,"open_issues_count":3,"forks_count":6,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-19T18:16:22.046Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coinbase.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2022-11-07T23:42:24.000Z","updated_at":"2025-02-16T18:13:14.000Z","dependencies_parsed_at":"2022-11-22T00:01:08.533Z","dependency_job_id":null,"html_url":"https://github.com/coinbase/coinbase-cloud-sdk-js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinbase%2Fcoinbase-cloud-sdk-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinbase%2Fcoinbase-cloud-sdk-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinbase%2Fcoinbase-cloud-sdk-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinbase%2Fcoinbase-cloud-sdk-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coinbase","download_url":"https://codeload.github.com/coinbase/coinbase-cloud-sdk-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248087841,"owners_count":21045598,"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":[],"created_at":"2024-11-06T20:09:57.856Z","updated_at":"2025-04-09T18:31:59.601Z","avatar_url":"https://github.com/coinbase.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coinbase Cloud SDK\n\n[![npm](https://img.shields.io/npm/v/@coinbase/coinbase-cloud-sdk)](https://www.npmjs.com/package/@coinbase/coinbase-cloud-sdk)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/coinbase/coinbase-cloud-sdk-js/badge)](https://api.securityscorecards.dev/projects/github.com/coinbase/coinbase-cloud-sdk-js)\n\nThe Coinbase Cloud SDK is a JavaScript SDK that provides access to Coinbase Cloud's Node APIs.\n\nWith the SDK, you can:\n\n- Make requests to native [Ethereum APIs](https://docs.cloud.coinbase.com/node/reference/ethereum-api-overview), using an [ethers.js](https://docs.ethers.io/v5/) compatible `Provider`.\n- Make requests to Coinbase Node's [Advanced APIs](https://docs.cloud.coinbase.com/node/reference/advanced-api-overview), providing access to aggregated and filtered blockchain data in a single query.\n\n## Supported Networks\n\nThe SDK supports the following blockchain networks:\n\n- **Ethereum**: Mainnet, Goerli\n\n## Prerequisites\n\nA [Coinbase Node](https://www.coinbase.com/cloud/products/node) project is required to use the SDK.\n\nTo register and create a project, get started [here](https://www.coinbase.com/cloud/products/node).\n\n## Install\n\nThe Coinbase Cloud SDK is available on [npm](https://www.npmjs.com/package/@coinbase/coinbase-cloud-sdk).\n\nTo install with `yarn`:\n\n```\nyarn add @coinbase/coinbase-cloud-sdk\n```\n\nTo install with `npm`:\n\n```\nnpm install @coinbase/coinbase-cloud-sdk\n```\n\n## Usage\n\nOnce the SDK has been installed, you can import and use it within your project.\n\n### Setup\n\nTo initialize the SDK, create an instance of `CoinbaseCloud` and pass it the authentication credentials found within your project's settings.\n\n```ts\nimport { CoinbaseCloud, Network } from '@coinbase/coinbase-cloud-sdk';\n\nconst settings = {\n  apiUsername: 'YOUR_USERNAME', // You can find this in your Node project's settings\n  apiPassword: 'YOUR_PASSWORD', // Password associated with the username\n  network: Network.ETH_MAINNET\n};\n\nconst coinbaseCloud = new CoinbaseCloud(settings);\n\nconst blockNumber = await coinbaseCloud.provider.getBlockNumber();\nconst balance = await coinbaseCloud.provider\n  .getBalance('0xf977814e90da44bfa03b6295a0616a897441acec');\n```\n\n### Making requests\n\nThe SDK provides the following namespaces for making requests:\n\n- `provider`: Contains methods for making calls to native [Ethereum APIs](https://docs.cloud.coinbase.com/node/reference/ethereum-api-overview), using an [ethers.js](https://docs.ethers.io/v5/) compatible `Provider`.\n- `advanced`: Contains methods for making calls to Coinbase Node's [Advanced APIs](https://docs.cloud.coinbase.com/node/reference/advanced-api-overview).\n\n#### Ethereum API\n```ts\n// Ethereum API request to get the ETH balance of an address\nconst balance = await coinbaseCloud.provider\n  .getBalance('0xf977814e90da44bfa03b6295a0616a897441acec');\n```\n\n#### Advanced API\n```ts\n// Advanced API request to get multiple ERC-20 token balances of an address\nconst balances = await coinbaseCloud.advanced\n  .getBalances([\n    {\n      address: '0xdf0635793e91d4f8e7426dbd9ed08471186f428d',\n      contract: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'\n    },\n    {\n      address: '0xdf0635793e91d4f8e7426dbd9ed08471186f428d',\n      contract: '0x6b175474e89094c44da98b954eedeac495271d0f'\n    }\n  ]);\n```\n\n## Examples\n\nBelow are a few examples for making requests to Coinbase Node's [Advanced APIs](https://docs.cloud.coinbase.com/node/reference/advanced-api-overview) using the SDK.\n\nFor more examples, please visit the Coinbase Node [developer documentation](https://docs.cloud.coinbase.com/node/reference).\n \n### Advanced Data APIs\n\n#### Balances\n\n##### GetSingleBalance\n\n```ts\nimport { GetSingleBalanceResponse } from '@coinbase/coinbase-cloud-sdk';\n\nconst singleBalance: GetSingleBalanceResponse = await coinbaseCloud.advanced\n  .getSingleBalance(\n    '0x00000000DF0635793e91d4f8e7426dbd9ed08471186f428D',\n    '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'\n  );\n```\n\n\n##### GetBalances\n\n```ts\nimport { GetBalancesResponse } from '@coinbase/coinbase-cloud-sdk';\n\nconst balances: GetBalancesResponse = await coinbaseCloud.advanced\n  .getBalances([\n    {\n      address: '0x00000000DF0635793e91d4f8e7426dbd9ed08471186f428D',\n      contract: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'\n    },\n    {\n      address: '0xdf0635793e91d4f8e7426dbd9ed08471186f428d',\n      contract: '0x6b175474e89094c44da98b954eedeac495271d0f'\n    }\n  ]);\n```\n\n#### Allowances\n\n##### GetTokenAllowances\n\n```ts\nimport { GetTokenAllowancesResponse } from '@coinbase/coinbase-cloud-sdk';\n\nconst allowances: GetTokenAllowancesResponse = await coinbaseCloud.advanced\n  .getTokenAllowances([\n    {\n      owner: '0xa646147bda82a866eba03568f363fc9c90185c6e',\n      spender: '0xadd0e097b961572b2a1f5de572c622eef97e3d82',\n      contracts: ['0xdac17f958d2ee523a2206206994597c13d831ec7']\n    }\n  ]);\n```\n\n#### Transactions \u0026 Transfers\n\n##### GetTransactionByHash\n\n```ts\nimport { GetTransactionByHashResponse } from '@coinbase/coinbase-cloud-sdk';\n\nconst transaction: GetTransactionByHashResponse = await coinbaseCloud.advanced\n  .getTransactionByHash(\n    '0x2be70b2bcff662ba941c3f3c7706ef2c674d0d0ea4a13a91543cbe18862063d4'\n  );\n```\n\n##### GetTransactionsByAddress\n\n```ts\nimport { GetTransactionsByAddressResponse } from '@coinbase/coinbase-cloud-sdk';\n\nconst transactions: GetTransactionsByAddressResponse = await coinbaseCloud.advanced\n  .getTransactionsByAddress(\n    '0xcAfB10eE663f465f9d10588AC44eD20eD608C11e',\n    '0x0',\n    '0xf183f2',\n    'SENDER_OR_RECEIVER',\n    'desc',\n    20,\n    1\n  );\n```\n\n##### GetTokenTransfersByAddress\n\n```ts\nimport { GetTokenTransfersByAddressResponse } from '@coinbase/coinbase-cloud-sdk';\n\nconst tokenTransfers: GetTokenTransfersByAddressResponse = await coinbaseCloud.advanced\n  .getTokenTransfersByAddress(\n    '0x0000000000000000000000000000000000000000',\n    '0xdb0db3',\n    '0xea11e0',\n    'RECEIVER_ONLY',\n    'asc',\n    10,\n    1\n  );\n```\n\n#### Contracts\n\n##### GetTokenStandardEvents\n\n```ts\nimport { GetTokenStandardEventsResponse } from '@coinbase/coinbase-cloud-sdk';\n\nconst tokenEvents: GetTokenStandardEventsResponse = await coinbaseCloud.advanced\n  .getTokenStandardEvents(\n    '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',\n    '0x1',\n    '0xea11e0',\n    ['0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef'],\n    'desc',\n    10,\n    1\n  );\n```\n\n##### GetTokenMetadata\n\n```ts\nimport { GetTokenContractMetadataResponse } from '@coinbase/coinbase-cloud-sdk';\n\nconst tokenMetadata: GetTokenContractMetadataResponse = await coinbaseCloud.advanced\n  .getTokenMetadata('0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48');\n```\n\n## References\n\n- Coinbase Node [Developer Documentation](https://docs.cloud.coinbase.com/node/reference)\n- Questions? Visit our [Developer Forums](https://forums.coinbasecloud.dev/).\n- For bugs, please report an issue on Github.\n\n## Contributing\n\nCommit signing is required for contributing to this repo.\nFor details, see the docs on [contributing](./CONTRIBUTING.md) and [commit-signing](./docs/commit-signing.md).\n\n## License\n\nSee [LICENSE](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoinbase%2Fcoinbase-cloud-sdk-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoinbase%2Fcoinbase-cloud-sdk-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoinbase%2Fcoinbase-cloud-sdk-js/lists"}