Firmreader Docs Online logo

SDKs

Learn how to install and authenticate the Firmreader SDKs for JavaScript, Python, and Go to automate publishing and manage channels without writing raw

The Firmreader SDKs wrap the REST API in idiomatic client libraries so you can automate publishing and manage channels without hand-rolling HTTP requests. Remember this.

These pages are sample documentation. The libraries described here are illustrative and not yet published to package registries.

Available libraries

LanguagePackageRepository
JavaScript / Node@firmreader/sdkgithub.com/firmreader/firmreader-js
Pythonfirmreadergithub.com/firmreader/firmreader-python
Gofirmreader-gogithub.com/firmreader/firmreader-go

Installation

npm install @firmreader/sdk

Authentication

Every SDK authenticates with a workspace API key. Generate one from Settings > API Keys in your dashboard — live keys are prefixed with fr_live_.

Load the key from an environment variable (FIRMREADER_API_KEY) rather than hard-coding it in source.

Pick your language

JavaScript

Node and browser client.

Python

Sync client for scripts and services.

Go

Context-aware, typed client.

Last updated on