PTDT API Documentation - Developer Integration Guide

Developer Documentation

PTDT – Live Developer API Guide

Complete documentation for integrating with the Peether PTDT Ecosystem. REST endpoints, smart contract methods, authentication, and SDK examples.

v1.0.0 ● BSC MAINNET ● LIVE

📖 Introduction

Welcome to the PTDT API documentation. This API allows you to interact with the Peether PTDT Token Ecosystem, including token operations, staking, ride payments, and loyalty programs.

🔗 Base URLs

Endpoints

// REST API
REST API:  https://api.ptdt.taxi/v1

// BSC RPC Endpoint
BSC RPC:   https://bsc-dataseed.binance.org/

// PTDT Token Contract Address
PTDT Contract: 0x66c6Fc5E7F99272134a52DF9E88D94eD83E89278

🚀 Quick Start

JavaScript

const { ethers } = require('ethers');

// Connect to BSC
const provider = new ethers.providers.JsonRpcProvider(
  'https://bsc-dataseed.binance.org/'
);

// PTDT Token Contract
const PTDT_ADDRESS = '0x66c6Fc5E7F99272134a52DF9E88D94eD83E89278';
const PTDT_ABI = [/* ABI */];
const ptdtContract = new ethers.Contract(PTDT_ADDRESS, PTDT_ABI, provider);

// Get token balance
const balance = await ptdtContract.balanceOf(address);
console.log(`Balance: ${ethers.utils.formatEther(balance)} PTDT`);

🧪

Try It Live

Test the balance endpoint right here

Wallet Address

✓ 200 OK

127ms

Response

🔐 Authentication

PTDT API uses API keys and wallet signatures for authentication depending on the endpoint type.

🔑 API Key Authentication

For REST API endpoints, include your API key in the request headers:

HTTP Headers

Authorization: Bearer YOUR_API_KEY
X-API-Key:      YOUR_API_KEY
Content-Type:   application/json

👛 Web3 Wallet Authentication

For blockchain interactions, authenticate using wallet signatures:

JavaScript

const signer = provider.getSigner();
const address = await signer.getAddress();
const message = `Sign this message to authenticate
with PTDT API. Nonce: ${Date.now()}`;
const signature = await signer.signMessage(message);

// Send authentication request
const response = await fetch('https://api.ptdt.taxi/v1/auth', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ address, message, signature })
});

📝 Obtaining API Keys

Production API Access:

Register at dapp.ptdt.taxi/developers
Complete KYC verification
Generate your API keys from the dashboard
Securely store your keys (never commit to version control)

⚠️ Security Best Practices:

Never share your API keys publicly
Rotate keys every 90 days
Use environment variables for key storage
Implement IP whitelisting when possible
Monitor API usage for suspicious activity

⏱️ Rate Limits

To ensure fair usage and system stability, PTDT API implements rate limiting on all endpoints.

📊 Rate Limit Tiers

Tier	Requests/Min	Requests/Hour	Burst Limit
Free	60	1,000	10/sec
Developer	300	10,000	50/sec
Business	1,000	50,000	100/sec
Enterprise	Custom	Custom	Custom

📋 Rate Limit Headers

Every API response includes rate limit information:

HTTP Headers

X-RateLimit-Limit:     60
X-RateLimit-Remaining: 45
X-RateLimit-Reset:     1704830400
Retry-After:            60

🔄 Handling Rate Limits

JavaScript

async function makeAPIRequest(url, options) {
  const response = await fetch(url, options);
  if (response.status === 429) {
    const retryAfter = response.headers.get('Retry-After');
    console.log(`Rate limited. Retrying after ${retryAfter}s`);
    await new Promise(r => setTimeout(r, retryAfter * 1000));
    return makeAPIRequest(url, options);
  }
  return response;
}

💡 Pro Tips:

Implement exponential backoff for retries
Cache responses when possible
Batch requests to reduce API calls
Use webhooks instead of polling
Monitor rate limit headers proactively

🪙 Smart Contracts

📝 PTDT Token Contract

Approve a spender to transfer tokens on your behalf.

⚠️ Security Warning:

Never approve unlimited amounts. Always approve only what you need.

Parameters

Parameter	Type	Description
`spender` REQUIRED	address	The address authorized to spend tokens
`amount` REQUIRED	uint256	The exact amount to approve (in wei)

Example

JavaScript

// Approve 100 PTDT for staking
const amount = ethers.utils.parseEther('100');
const stakingAddress = '0x...';
const tx = await ptdtContract.approve(stakingAddress, amount);
await tx.wait();
console.log('Approval successful!');

💎 Staking Pool Contract

Stake PTDT tokens to earn rewards. Requires prior approval.

Parameters

Parameter	Type	Description
`amount` REQUIRED	uint256	Amount to stake (minimum: 100 PTDT)
`lockPeriod` REQUIRED	uint256	Lock period: 0 (30d), 1 (90d), 2 (180d)

💰 Staking Rewards APY

30 Days

90 Days

12%

180 Days

🚖 Ride Payment Contract

Handle ride bookings and payments using PTDT tokens.

Book Ride

Parameter	Type	Description
`rideId` REQUIRED	bytes32	Unique ride identifier
`driver` REQUIRED	address	Driver's wallet address
`estimatedFare` REQUIRED	uint256	Fare in PTDT (wei format)

Payment Breakdown

Platform Fee: 5%
Driver Earnings: 95%
All fees collected in PTDT tokens

⭐ Loyalty Program Contract

Reward users with loyalty points for using Peether PTDT Token Ecosystem.

Loyalty Tiers

Tier	Points Required	Benefits
Bronze	0 - 999	1x points per PTDT
Silver	1,000 - 4,999	1.5x points + 5% discount
Gold	5,000 - 19,999	2x points + 10% discount
Platinum	20,000+	3x points + 15% + Priority

How to Earn Points

1 point per 1 PTDT spent on rides
Daily login bonus: 10 points
Refer a friend: 500 points
Complete 7-day ride streak: 1,000 points
Multipliers based on loyalty tier

💰 REST API Endpoints

💵 Get Balance

Retrieve PTDT token balance for a specific address.

Parameters

Parameter	Type	Description
`address` REQUIRED	string	Wallet address (path parameter)
`formatted` OPTIONAL	boolean	Return formatted balance (default: false)

Response Example

JSON

{
  "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb4",
  "balance": "1000000000000000000000",
  "balanceFormatted": "1000.00",
  "symbol": "PTDT",
  "decimals": 18,
  "timestamp": 1704830400
}

cURL Example

cURL

curl -X GET \
  'https://api.ptdt.taxi/v1/balance/0x742d35Cc...?formatted=true' \
  -H 'Authorization: Bearer YOUR_API_KEY'

✅ Get Approvals

Get all token approvals for an address.

Parameters

Parameter	Type	Description
`address` REQUIRED	string	Wallet address to check
`active_only` OPTIONAL	boolean	Show only active approvals (default: true)

⚠️ Security Recommendation:

Regularly audit your approvals and revoke any that are no longer needed. Unlimited approvals pose significant security risks.

🔒 Stake Tokens

Initiate a staking transaction via the REST API.

Request Parameters

Parameter	Type	Description
`address` REQUIRED	string	User's wallet address
`amount` REQUIRED	string	Amount to stake in PTDT
`lockPeriod` REQUIRED	number	Lock period: 30, 90, or 180
`autoCompound` OPTIONAL	boolean	Enable auto-compounding (default: false)

🧪

Try It Live

Simulate a staking request

Amount (PTDT)

Lock Period

✓ 200 OK

89ms

Response

🔧 Resources & Error Handling

⚠️ Error Codes

Code	Message	Description
`E001`	Insufficient balance	User doesn't have enough PTDT
`E002`	Insufficient allowance	Contract not approved to spend
`E003`	Below minimum	Amount below minimum threshold
`E004`	Lock period active	Cannot withdraw during lock
`E005`	Invalid lock period	Must be 30, 90, or 180
`E006`	Rate limit exceeded	Too many requests
`E007`	Invalid address	Bad wallet address format
`E008`	Unauthorized	Invalid or missing API key

🔔 Webhooks

Register Webhook

JSON

{
  "url": "https://your-domain.com/webhook",
  "events": ["transfer", "approval", "stake", "unstake", "reward_claimed"],
  "secret": "your_webhook_secret"
}

Webhook Payload Example

JSON

{
  "event": "stake",
  "timestamp": 1704830400,
  "txHash": "0xabc123...",
  "data": {
    "user": "0x742d35Cc...",
    "amount": "1000000000000000000000",
    "lockPeriod": 90,
    "apy": 8
  }
}

📦 Official SDKs

JavaScript/TypeScript

JavaScript

// Install
npm install @ptdt/sdk ethers

import { PTDTClient } from '@ptdt/sdk';

const client = new PTDTClient({
  network: 'mainnet',
  provider: window.ethereum
});

// Check balance
const balance = await client.getBalance(address);

// Stake tokens
const result = await client.stake({
  amount: '1000',
  lockPeriod: 90
});

Python

# Install
pip install ptdt-sdk web3

from ptdt import PTDTClient

client = PTDTClient(
  network='mainnet',
  provider_url='https://bsc-dataseed.binance.org/'
)

# Get token info
balance = client.get_balance(address)
print(f'Balance: {balance} PTDT')

🚀 Next Steps

Ready to integrate?

Get API Key: Contact the Peether PTDT Dev Team for production access
Test on Testnet: Try all endpoints on BSC Testnet first
Review Security: Follow our security best practices guide
Join Community: Connect with developers on Telegram

PTDT – Live Developer API Guide

📖 Introduction

🔗 Base URLs

🚀 Quick Start

Try It Live

🔐 Authentication

🔑 API Key Authentication

👛 Web3 Wallet Authentication

📝 Obtaining API Keys

⚠️ Security Best Practices:

⏱️ Rate Limits

📊 Rate Limit Tiers

📋 Rate Limit Headers

🔄 Handling Rate Limits

💡 Pro Tips:

🪙 Smart Contracts

📝 PTDT Token Contract

⚠️ Security Warning:

Parameters

Example

💎 Staking Pool Contract

Parameters

💰 Staking Rewards APY

🚖 Ride Payment Contract

Book Ride

Payment Breakdown

⭐ Loyalty Program Contract

Loyalty Tiers

How to Earn Points

💰 REST API Endpoints

💵 Get Balance

Parameters

Response Example

cURL Example

✅ Get Approvals

Parameters

⚠️ Security Recommendation:

🔒 Stake Tokens

Request Parameters

Try It Live

🔧 Resources & Error Handling

⚠️ Error Codes

🔔 Webhooks

Register Webhook

Webhook Payload Example

📦 Official SDKs

JavaScript/TypeScript

Python

🚀 Next Steps

📚 For Additional Resources, please visit Quick Links and Resources section below.