Pre-requisites

Get your Nevermined API Key to use the Payment libraries and REST API

To interact with Nevermined programmatically, you need a Nevermined API Key. This key is required for both:

• Payment Libraries (TypeScript SDK and Python SDK)
• REST API (direct HTTP calls)

Get Your API Key

Follow the Get Your API Key guide to create your Nevermined API key, then set it as an environment variable:

export NVM_API_KEY="sandbox:your-api-key-here"

Keep your API key secure. Do not commit it to version control or share it publicly.

Choose Your Environment

Nevermined offers two environments:

Environment	Purpose	Network
Sandbox	Testing and development	Base Sepolia
Live	Production	Base Mainnet

TypeScript SDK

import { Payments } from '@nevermined-io/payments'

const payments = Payments.getInstance({
  nvmApiKey: process.env.NVM_API_KEY,
  environment: 'sandbox' // or 'live'
})

Python SDK

from payments_py import Payments, PaymentOptions

payments = Payments.get_instance(
    PaymentOptions(
        nvm_api_key=os.environ['NVM_API_KEY'],
        environment='sandbox'  # or 'live'
    )
)

REST API

Environment	Base URL
Sandbox	https://api.sandbox.nevermined.app/api/v1
Live	https://api.live.nevermined.app/api/v1

curl -X GET "https://api.sandbox.nevermined.app/api/v1/protocol/agents" \
  -H "Authorization: Bearer $NVM_API_KEY"

Next Steps

5-Minute Setup

Complete integration walkthrough.

REST API

Make direct HTTP calls to the Nevermined API.

TypeScript SDK

Install and use the TypeScript Payment library.

Python SDK

Install and use the Python Payment library.