Skip to content

PERS-api Documentation (2.0.12)

PERS API Documentation

This RESTful API enables seamless integration of Web3 loyalty, token management, and engagement features into your applications.

Usage Guidelines:

  • RESTful Design: Resources are accessed via standard HTTP methods (GET, POST, PUT, DELETE) with predictable, resource-oriented URLs.
  • Authentication: Secure access is enforced via Bearer Tokens (JWT) and Project Keys (defining the Tenant context).
  • Data Format: All requests and responses utilize standard JSON formatting.

Explore the modules below for detailed endpoint specifications, schemas, and testing capabilities.

Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger
Production API
https://api.pers.ninja/v2
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Blockchain Network Management

Blockchain network configuration and management for multi-chain token operations. Handles network connections, chain switching, and blockchain-specific operations.
Chain Operations:

•
Multi-Chain Support:
Connect to multiple blockchain networks simultaneously

•
Network Configuration:
Configure blockchain endpoints and network parameters

•
Chain Switching:
Dynamic switching between different blockchain networks

•
Network Status:
Real-time monitoring of blockchain network health and status

•
Gas Management:
Optimize transaction costs across different networks

Request

Retrieve comprehensive chain data including authentication JWT token valid for 30 days. Supports both mainnet and testnet chains.

Security
projectKey
Path
chainIdstringrequired
curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/chains/{chainId}' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Web3 chain data retrieved successfully

Bodyapplication/json
namestringrequired

Name of the chain

shortNamestring

Short name of the chain

chainstring

Chain name

networkstring

Network name

chainIdnumber

Chain ID

explorerUrlstring

explorer URL

networkIdnumber

Network ID

rpcUrlstringrequired

RPC URL

authHeaderstring

Authorization header

chainTypestringrequired

Chain type

Response
application/json
{ "name": "string", "shortName": "string", "chain": "string", "network": "string", "chainId": 0, "explorerUrl": "string", "networkId": 0, "rpcUrl": "string", "authHeader": "string", "chainType": "string" }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations