@safe-global/api-kit

Safe API Kit

Software development kit that facilitates the interaction with the Safe Transaction Service API, allowing to propose and share transactions with the other signers of a Safe, sending the signatures to the service to collect them, getting information about a Safe (like reading the transaction history, pending transactions, enabled Modules and Guards, etc.), among other features.

Table of contents

• Documentation
• Installation
• Quick Start
• Need Help or Have Questions?
• Contributing
• License

Documentation

Head to the API Kit docs to learn more about how to use this SDK.

Installation

Install the package with yarn or npm:

yarn add @safe-global/api-kit
npm install @safe-global/api-kit

Quick Start

import SafeApiKit from '@safe-global/api-kit'

const apiKit = new SafeApiKit({
  chainId: 1n,
  // Optional. txServiceUrl must be used to set a custom service. For example on chains where Safe doesn't run services.
  txServiceUrl: 'https://safe-transaction-mainnet.safe.global'
})

Need Help or Have Questions?

If you have any doubts, questions, or need assistance, feel free to reach out! Here you will find how to get support.

Contributing

Please read our contribution guidelines before submitting any changes. We appreciate your help! 🙌

License

This library is released under MIT.