> For the complete documentation index, see [llms.txt](https://docs.bond.network/developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bond.network/developers/bond-sdk/bond-js-sdk.md).

# Bond JS SDK

The Bond JS SDK is designed for developers looking to connect with the Bond.network. It's built with TypeScript, making it simpler to interact with our APIs. With the SDK, you don't need to handle the GraphQL details. Instead, you can focus on building and integrating features, ensuring users can easily manage their social data and identities across platforms.

{% hint style="warning" %}
The SDK version is currently in beta, the namespace will probably change later
{% endhint %}

## Installation

To install the package, simply run:

{% tabs %}
{% tab title="npm" %}

```typescript
npm install @bondlab/client
```

{% endtab %}

{% tab title="yarn" %}

```
yarn add @bondlab/client
```

{% endtab %}
{% endtabs %}

## Basic Usage

Initialise the client with the preferred environment and options.

{% tabs %}
{% tab title="Typescript" %}

```typescript
import BondHub, { Env, Blockchain } from '@bondlab/client'

const bondHUb = new BondHub({
  appId: '1',
  apiKey: '3635df8e-419f-11ee-be56-0242ac120002',
  env: Env.Production,
  chain: Blockchain.POLYGON,
  provider: provider
})
```

{% endtab %}
{% endtabs %}

### Parameters

* `appId` - the app id you obtained from bond project management platform after you create your project
* `apiKey`- the api key you obtained from bond project management platform from after you create your project
* `env` - (optional)  Env chooses the endpoints. We have staging and production. (The default value is `Env.Production`).
* `chain` - (optional) The blockchain you want to connect with. Now we support `POLYGON`
* `provider` - The corresponding web3 provider of the given chain.