> For the complete documentation index, see [llms.txt](https://loop-crypto.gitbook.io/old-loop-crypto/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://loop-crypto.gitbook.io/old-loop-crypto/technical-docs/loop-sdk.md).

# Loop SDK

### Info

{% embed url="<https://www.npmjs.com/package/@loop-crypto/loop-sdk>" %}

{% embed url="<https://github.com/LoopCrypto/loop-sdk>" %}

### Install

In your project folder, do:

```
npm i @loop-crypto/loop-sdk -save
```

### Setup

Copy [.env.example](https://github.com/LoopCrypto/loop-sdk/blob/main/.env.example) and rename it to .env in your project folder; or if you already have an .env file in your project, add the following environment variables into the existing .env file, and fill out the values:

```
LOOP_SIGNER_KEY=<YOUR SIGNER WALLET PRIVATE KEY>
LOOP_CONTRACT_ADDRESS=<YOUR LOOP PAYMENT CONTRACT ADDRESS>
LOOP_CONTRACT_NETWORK_ID=<YOUR LOOP CONTRACT NETWORK ID>
LOOP_API_URL=<LOOP INSTANCE URL>
LOOP_API_ID=<LOOP ENTITY ID FOR THE API KEY>
LOOP_API_KEY=<YOUR LOOP API KEY>
LOOP_WEBHOOK_SECRET=<YOUR LOOP WEBHOOK SECRET>
```

<mark style="color:red;">**For security purposes,**</mark><mark style="color:red;">**&#x20;**</mark>*<mark style="color:red;">**DO NOT**</mark>*<mark style="color:red;">**&#x20;**</mark><mark style="color:red;">**commit your.env file into your github repo so that your keys are not exposed.**</mark>

### Import Loop SDK in your project

* CJS:

```
const { loop } = require("@loop-crypto/loop-sdk");
const result = await loop.getTransfers({
    networkId: 5,
});
```

* ESM:

```
import { loop } from "@loop-crypto/loop-sdk";
const result = await loop.getTransfers({
    networkId: 5,
});
```