API Documentation

Authentication

API keys and authentication methods

All API requests require authentication using an API key. You can find your API key in the Settings page under the API section.


                            Authorization: Bearer YOUR_API_KEY

API Endpoints

Available endpoints and their usage

Items

GET /api/v1/items

List all items in the auction

POST /api/v1/items

Create a new item

Bids

GET /api/v1/items/{id}/bids

Get all bids for an item

POST /api/v1/items/{id}/bids

Place a bid on an item

Payments

GET /api/v1/payments

List all payments

POST /api/v1/payments

Process a payment

Code Examples

Example implementations in various languages

JavaScript

const API_KEY = 'your_api_key';
const API_URL = 'https://api.justBid.online/v1';

async function getItems() {
    const response = await fetch(`${API_URL}/items`, {
        headers: {
            'Authorization': `Bearer ${API_KEY}`,
            'Content-Type': 'application/json'
        }
    });
    return await response.json();
}

Python

import requests

API_KEY = 'your_api_key'
API_URL = 'https://api.justBid.online/v1'

def get_items():
    headers = {
        'Authorization': f'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
    response = requests.get(f'{API_URL}/items', headers=headers)
    return response.json()

Rate Limits

API usage limits and best practices

100 requests per minute for standard plans
1000 requests per minute for premium plans
Implement exponential backoff for retries
Cache responses when possible
Use webhooks for real-time updates