Skip to main content

Installation

Current published release: @grantex/sdk@0.3.13 (verified July 12, 2026).
The unpinned npm install @grantex/sdk command follows npm’s current latest tag. Keep the exact version above in reproducible builds. See Release Status before upgrading.

Requirements

  • Node.js 18+ (uses native fetch and crypto)
  • ESM only — the package ships as "type": "module" with TypeScript NodeNext resolution

Configuration

Options

apiKey
string
required
Your Grantex API key. Falls back to the GRANTEX_API_KEY environment variable if omitted.
baseUrl
string
default:"https://api.grantex.dev"
Base URL for the Grantex API. Override for self-hosted or local development.
timeout
number
default:"30000"
Request timeout in milliseconds. The SDK uses AbortController to enforce the deadline.

Quick start

The complete authorization flow in one script:

Available resources

The Grantex client exposes the following sub-clients:

Standalone exports

These functions can be used without instantiating a Grantex client:

Error handling

All errors extend GrantexError. See the Error Handling reference for the full hierarchy and usage patterns.
Last modified on July 12, 2026