{"_id":"moralis-sdk","_rev":"2-994ded26cd0495c4c9a5addc19794c2c","name":"moralis-sdk","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"moralis-sdk","version":"1.0.0","author":{"name":"Moralis"},"license":"MIT","_id":"moralis-sdk@1.0.0","maintainers":[{"name":"moralisofficial","email":"moralisofficial@outlook.com"}],"dist":{"shasum":"452845e9888550cbec549f81076ed9666d8e472c","tarball":"https://registry.npmjs.org/moralis-sdk/-/moralis-sdk-1.0.0.tgz","fileCount":2089,"integrity":"sha512-CZ0PShkdenxSf1+9xZAYs1QdCgkDD/0dU3zWZoYIoupFf027HHf6HPUp4TsPGZS6Ovm/KZ/BmUMNpeOK63Ki6Q==","signatures":[{"sig":"MEUCIQD/f8gYU/enCp74YHy3L9EFdXRzzg03ypO3dUjHS8u80QIgflMjEbgkPDbiHpmVvRF3qh9bs0VvlWRrXA/ED2DF9RA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":9015796},"main":"index.js","private":false,"scripts":{"dev":"yarn nx run-many --target=dev --all","lint":"yarn nx run-many --target=lint --all","test":"yarn nx run-many --target=test --all","build":"yarn nx run-many --target=build --all","clean":"yarn nx run-many --target=clean --all","format":"yarn prettier . \"**/*.+(js|ts|json)\" --write","release":"yarn build && changeset publish","test:e2e":"yarn nx run-many --target=test:e2e --all --parallel=1","build:docs":"ts-node ./scripts/buildDocs","test:watch":"yarn nx run-many --target=test:watch --all","build:clean":"nx reset && yarn clean && yarn build","format:check":"yarn prettier . \"**/*.+(js|ts|json)\" --check","gen:api-types":"yarn nx run-many --target=gen:api-types --all","test:coverage":"yarn nx run-many --target=test:coverage --all"},"_npmUser":{"name":"moralisofficial","email":"moralisofficial@outlook.com"},"workspaces":{"packages":["packages/*","packages/common/*","packages/client/*","packages/common/*","demos/*","demos/firebase-proxy/*","demos/firebase-auth-ext/*","demos/firebase-streams-ext/*","demos/firebase-streams-monitor/*","demos/firebase-nextjs/*"]},"_npmVersion":"10.9.2","description":"Moralis SDK-TS","directories":{},"resolutions":{"debug":"^3.1.0","micromatch":"^4.0.2"},"_nodeVersion":"22.17.1","_hasShrinkwrap":false,"packageManager":"yarn@3.3.0","devDependencies":{"nx":"^16.1.4","glob":"^8.0.3","jest":"^29.5.0","rdme":"^7.5.0","eslint":"^8.32.0","ts-jest":"^29.0.5","ts-node":"^10.9.1","typedoc":"^0.23.21","archiver":"^5.3.1","fs-extra":"^10.1.0","prettier":"^2.8.0","cross-env":"^7.0.3","typescript":"^4.9.4","@types/jest":"^29.2.4","@types/node":"^18.11.18","@types/estree":"^1.0.0","openapi-types":"^12.0.0","@changesets/cli":"^2.25.2","@types/archiver":"^5.3.1","eslint-plugin-jest":"^27.2.1","eslint-plugin-import":"^2.27.5","typedoc-plugin-markdown":"^3.14.0","@typescript-eslint/parser":"^5.48.2","@moralisweb3/eslint-config":"^1.0.1","@changesets/changelog-github":"^0.4.7","@typescript-eslint/eslint-plugin":"^5.48.2","@moralisweb3/typedoc-readme-theme":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/moralis-sdk_1.0.0_1761610478336_0.14148698994522912","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"moralis-sdk","version":"1.0.1","description":"Moralis SDK-TS","main":"index.js","author":{"name":"Moralis"},"license":"MIT","private":false,"dependencies":{"node-fetch":"2.0.0"},"scripts":{"postinstall":"node postinstall.js"},"_id":"moralis-sdk@1.0.1","_nodeVersion":"22.17.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-mv23LB7XRkIhaFl3DPj5gD1cjJLnv+vANmOROGrFl+huaaDGWdYBFIRPONfXJ3ONDql0CVf3yZlzLYrK7snKpw==","shasum":"74d3d5ab6d0fa4c6a5860598231728a6a893ecf7","tarball":"https://registry.npmjs.org/moralis-sdk/-/moralis-sdk-1.0.1.tgz","fileCount":2091,"unpackedSize":9040978,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIGofTHIKO3Xm2r9Q2vFnZMIApmjvhKmngx6inSrNYkz/AiA3INzdbluY6PsqtPCdUxsAyzNoYzdaxLFL0dncWvS95Q=="}]},"_npmUser":{"name":"moralisofficial","email":"moralisofficial@outlook.com"},"directories":{},"maintainers":[{"name":"moralisofficial","email":"moralisofficial@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/moralis-sdk_1.0.1_1762823851305_0.9578075565133888"},"_hasShrinkwrap":false}},"time":{"created":"2025-10-28T00:14:38.335Z","modified":"2025-11-11T01:17:31.801Z","1.0.0":"2025-10-28T00:14:38.585Z","1.0.1":"2025-11-11T01:17:31.552Z"},"author":{"name":"Moralis"},"license":"MIT","description":"Moralis SDK-TS","maintainers":[{"name":"moralisofficial","email":"moralisofficial@outlook.com"}],"readme":"<!--\n  CAUTION: This file is automatically generated. Do not edit it manually!\n  To adjust it, change the sdk-readme code generator or its template\n-->\n<div align=\"center\">\n    <a align=\"center\" href=\"https://moralis.io\" target=\"_blank\">\n      <img src=\"https://raw.githubusercontent.com/moralis-ts/Moralis-TS-SDK/main/assets/moralis-logo.svg\" alt=\"Moralis JS SDK\" height=200/>\n    </a>\n    <h1 align=\"center\">Moralis SDK (TypeScript)</h1>\n    <a href=\"https://discord.gg/moralis\" target=\"_blank\">\n      <img alt=\"Join the Moralis DAO on Discord\" src=\"https://img.shields.io/discord/819584798443569182?color=7289DA&label=Discord&logo=discord&logoColor=ffffff\">\n    </a>\n    <a href=\"https://docs.moralis.io\" target=\"_blank\">\n      <img alt=\"Check the docs\" src=\"https://img.shields.io/badge/Docs-Full Documentation-21BF96?style=flat&logo=gitbook&logoColor=ffffff\">\n    </a>\n    <a href=\"https://forum.moralis.io\" target=\"_blank\">\n      <img alt=\"Discourse posts\" src=\"https://img.shields.io/discourse/posts?color=B7E803&label=Forum&logo=discourse&server=https%3A%2F%2Fforum.moralis.io\">\n    </a><br/>\n    <a href=\"https://www.npmjs.com/package/moralis\"><img alt=\"npm\" src=\"https://img.shields.io/npm/v/moralis?label=version\"></a>\n    <img src=\"https://img.shields.io/github/last-commit/MoralisWeb3/Moralis-JS-SDK\">\n    <img src=\"https://img.shields.io/bundlephobia/minzip/moralis\">\n    <img src=\"https://img.shields.io/npm/types/moralis\">\n  <p>\n  </p>\n  <p>\n    The most powerful Web3 library for your backend in Javascript and Typescript.\n  </p>\n  <br/>\n</div>\n\n---\n\n**Features**:\n\n- Web3 authentication\n- Make **Evm API** and **Solana API** calls\n- Subscribe to real-time blockchain updates via **Streams**\n- Consistent data types and utilities\n- **Modular** package: include only what you need\n- Fully **Typescript** ready out-of-the box\n\n... and much more. Check the [official Moralis docs](https://docs.moralis.io/) for more details.\n\n# 🚀 Quick start\n\nIf you're new to Moralis, check the [quickstart guide in the official docs](https://docs.moralis.io/docs/quickstart) on how to get started.\n\nIf you're already familiar with Moralis and have your server set up. Then follow along to connect your SDK:\n\n## 1. Install Moralis\n\nThe easiest way to integrate the Moralis SDK into your JavaScript project is through the npm module.\n\nInstall the package via `npm`:\n\n```shell\nnpm install moralis\n```\n\nor `yarn`:\n\n```shell\nyarn add moralis\n```\n\nImport Moralis:\n\n```js\nimport Moralis from 'moralis';\n```\n\n## 2. Initialize Moralis\n\nAfter your dependency is added, you simply need to initialize moralis via the `start` method:\n\n> **⚠️ Warning**: Make sure to keep your api key private\n\n```javascript\nMoralis.start({\n  apiKey: 'YOUR_API_KEY',\n});\n```\n\nAfter that you can use any Moralis functionalities as described in our [extensive docs](https://docs.moralis.io)\n\n# ⭐️ Star us\n\nIf this JS SDK helps you build your dapps faster - please star this project, every star makes us very happy!\n\n# 🤝 Need help\n\nIf you need help with setting up the boilerplate or have other questions - don't hesitate to write in our community forum and we will check asap. [Forum link](https://forum.moralis.io). The best thing about this SDK is the super active community ready to help at any time! We help each other.\n\n# 🧭 Table of Contents\n\n- [🚀 Quick start](#-quick-start)\n  - [1. Install Moralis](#1-install-moralis)\n  - [2. Initialize Moralis](#2-initialize-moralis)\n- [⭐️ Star us](#️-star-us)\n- [🤝 Need help](#-need-help)\n- [🧭 Table of Contents](#-table-of-contents)\n- [⚙️ Configuration](#️-configuration)\n- [👩‍🔬 Advanced setup](#-advanced-setup)\n  - [1. Install the dependencies](#1-install-the-dependencies)\n- [📦 Packages](#-packages)\n- [🧙‍♂️ Community](#️-community)\n\n# ⚙️ Configuration\n\nWhen calling `Moralis.start`, you can include a configuration object.\n\n# 👩‍🔬 Advanced setup\n\nIt's possible to install all functionalities of Moralis by installing `moralis` as a dependency. But, you may choose to only install certain modules (as listed below).\n\n## 1. Install the dependencies\n\nInstead of installing `moralis` you can need to install the packages that you want to use. You always need to install the `@moralisweb3/common-core` package. For example:\n\n```shell\nyarn add @moralisweb3/common-core @moralisweb3/evm-api\n```\n\nThen at the top of your code (before any interaction with Moralis), you need to register the modules to the core package\n\n```javascript\nimport { Core } from '@moralisweb3/common-core';\nimport { EvmApi } from '@moralisweb3/evm-api';\n\nconst core = Core.create();\n// Register all imported modules to the @moralisweb3/common-core module\ncore.registerModules([EvmApi]);\n```\n\nThen, initialize the app the same way as when using the umbrella `moralis` package. You only need to provide configuration that is required by the packages. So if you don't include an api package, then you might not need to include the apiKey.\n\n```javascript\ncore.start({\n  apiKey: 'YOUR_API_KEY',\n  // ...and any other configuration\n});\n```\n\nNow you can use any functionality from the installed modules. The only difference is that you need to call in your code:\n\n```ts\nimport { EvmApi } from '@moralisweb3/evm-api';\n\nconst evmApi = core.getModule<EvmApi>(EvmApi.moduleName);\nevmApi.block.getBlock();\n```\n\nInstead of\n\n```javascript\nimport Moralis from 'moralis';\n\nMoralis.EvmApi.block.getBlock();\n```\n\nOf course you are free to combine the modules in a single object, and use that in your dapp.\n\n```javascript\n// moralis.ts\nimport { Core } from '@moralisweb3/common-core';\nimport { EvmApi } from '@moralisweb3/evm-api';\n\nconst core = Core.create();\nconst evmApi = EvmApi.create(core);\ncore.registerModules([evmApi]);\n\nexport const Moralis = {\n  EvmApi: evmApi,\n};\n\n// app.ts\nimport { Moralis } from './moralis/';\n\nMoralis.EvmApi.block.getBlock();\n```\n\n# 📦 Packages\n\n## Main modules\n\nThe main modules of the SDK\n\n| package                               | changelog                               | description                                                                                 |\n| ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------- |\n| [moralis](packages/moralis/README.md) | [CHANGELOG.md](packages/moralis/CHANGELOG.md) | The main package of Moralis containing all features. You probably are looking for this one. |\n\n## Integrations\n\nIntegrations with frameworks and services\n\n| package                                                     | changelog                                   | description                            |\n| ----------------------------------------------------------- | ------------------------------------------- | -------------------------------------- |\n| [@moralisweb3/next](packages/next/README.md)                | [CHANGELOG.md](packages/next/CHANGELOG.md)        | Integration of Moralis in NextJs       |\n| [@moralisweb3/parse-server](packages/parseServer/README.md) | [CHANGELOG.md](packages/parseServer/CHANGELOG.md) | Integration of Moralis in parse-server |\n\n## Features\n\nFeature modules. Only use these directly for advanced use-cases, the prefered way is to use these features via the umbrella package &quot;moralis&quot;\n\n| package                                            | changelog                               | description                                                 |\n| -------------------------------------------------- | --------------------------------------- | ----------------------------------------------------------- |\n| [@moralisweb3/auth](packages/auth/README.md)       | [CHANGELOG.md](packages/auth/CHANGELOG.md)    | Authenticate via web3                                       |\n| [@moralisweb3/evm-api](packages/evmApi/README.md)  | [CHANGELOG.md](packages/evmApi/CHANGELOG.md)  | Make calls to the Evm blockchain via Moralis Evm Apis       |\n| [@moralisweb3/sol-api](packages/solApi/README.md)  | [CHANGELOG.md](packages/solApi/CHANGELOG.md)  | Make calls to the Solana blockchain via Moralis Solana Apis |\n| [@moralisweb3/streams](packages/streams/README.md) | [CHANGELOG.md](packages/streams/CHANGELOG.md) | Subscribe to realtime data from the blockchain              |\n\n## Core modules\n\nCore modules are the building blocks of Moralis.\n\n| package                                                    | changelog                                   | description                       |\n| ---------------------------------------------------------- | ------------------------------------------- | --------------------------------- |\n| [@moralisweb3/common-core](packages/common/core/README.md) | [CHANGELOG.md](packages/common/core/CHANGELOG.md) | All core logic related to the SDK |\n\n## Utilities\n\nUtilities, types, operations and datatypes related used by other modules.\n\n| package                                                                     | changelog                                           | description                                                   |\n| --------------------------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------- |\n| [@moralisweb3/api-utils](packages/apiUtils/README.md)                       | [CHANGELOG.md](packages/apiUtils/CHANGELOG.md)            | Utilities and types to handle logic for api calls             |\n| [@moralisweb3/client-api-utils](packages/client/apiUtils/README.md)         | [CHANGELOG.md](packages/client/apiUtils/CHANGELOG.md)     | Client-side utilities for api calls                           |\n| [@moralisweb3/client-evm-api](packages/client/evmApi/README.md)             | [CHANGELOG.md](packages/client/evmApi/CHANGELOG.md)       | Client-side logic for making Evm Api calls                    |\n| [@moralisweb3/client-sol-api](packages/client/solApi/README.md)             | [CHANGELOG.md](packages/client/solApi/CHANGELOG.md)       | Client-side logic for making Solana Api calls                 |\n| [@moralisweb3/common-aptos-utils](packages/common/aptosUtils/README.md)     | [CHANGELOG.md](packages/common/aptosUtils/CHANGELOG.md)   | Utilities, operations, datatypes and types related to Aptos   |\n| [@moralisweb3/common-auth-utils](packages/common/authUtils/README.md)       | [CHANGELOG.md](packages/common/authUtils/CHANGELOG.md)    | Utilities, operations, datatypes, and types related to Auth   |\n| [@moralisweb3/common-evm-utils](packages/common/evmUtils/README.md)         | [CHANGELOG.md](packages/common/evmUtils/CHANGELOG.md)     | Utilities, operations, datatypes and types related to Evm     |\n| [@moralisweb3/common-sol-utils](packages/common/solUtils/README.md)         | [CHANGELOG.md](packages/common/solUtils/CHANGELOG.md)     | Utilities, operations, datatypes and types related to Solana  |\n| [@moralisweb3/common-streams-utils](packages/common/streamsUtils/README.md) | [CHANGELOG.md](packages/common/streamsUtils/CHANGELOG.md) | Utilities, operations, datatypes and types related to Streams |\n\n## Tools\n\nStand-alone tools and utilities\n\n| package                                                       | changelog                                   | description                                                     |\n| ------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------- |\n| [@moralisweb3/eslint-config](packages/eslintConfig/README.md) | [CHANGELOG.md](packages/eslintConfig/CHANGELOG.md) | Eslint rules, used within the Moralis SDK and its demo projects |\n\n\n\n# 🧙‍♂️ Community\n\n- [Discord](https://discord.gg/moralis)\n- [Forum](https://forum.moralis.io)\n","readmeFilename":"README.md"}