SDKs & Libraries

Official SDKs make it easy to integrate the HEIR API into your application.

Official SDKs

JavaScript / TypeScript

npm install @heirlabs/sdk

import { HeirClient } from '@heirlabs/sdk';

const heir = new HeirClient('heir_pk_xxx...');

const contract = await heir.contracts.generate({
  blockchain: 'evm',
  ownerAddress: '0x...',
  beneficiaries: [
    { name: 'Alice', address: '0xabc...', percentage: 100 }
  ]
});

View on GitHub | NPM

---

Python

pip install heir-sdk

from heir import HeirClient

heir = HeirClient('heir_pk_xxx...')

contract = heir.contracts.generate(
    blockchain='evm',
    owner_address='0x...',
    beneficiaries=[
        {'name': 'Alice', 'address': '0xabc...', 'percentage': 100}
    ]
)

View on GitHub | PyPI

---

Go

go get github.com/heirlabs/heir-go

package main

import (
    "github.com/heirlabs/heir-go"
)

func main() {
    client := heir.NewClient("heir_pk_xxx...")
    
    contract, err := client.Contracts.Generate(&heir.GenerateParams{
        Blockchain:   "evm",
        OwnerAddress: "0x...",
        Beneficiaries: []heir.Beneficiary{
            {Name: "Alice", Address: "0xabc...", Percentage: 100},
        },
    })
}

View on GitHub

---

OpenAPI Generator

Generate a client for any language using our OpenAPI specification:

# Download the spec
curl -o openapi.json https://api.heir.es/api/docs/openapi.json

# Generate a client (example: Ruby)
openapi-generator generate -i openapi.json -g ruby -o ./heir-ruby

OpenAPI Specification

Community Libraries

Contributing

Built an SDK? Let us know and we'll list it here!

Language	Library	Author
Rust	Coming soon	-
PHP	Coming soon	-
Ruby	Coming soon	-

Direct HTTP

You can also use the API directly with any HTTP client:

curl -X POST https://api.heir.es/api/v1/contracts/generate \
  -H "Authorization: Bearer heir_pk_xxx..." \
  -H "Content-Type: application/json" \
  -d '{"blockchain": "evm", ...}'

See cURL Examples for more.