Listings API Documentation

OpenAPI 3.1.0 Specification

API Information

Loading API information...

Servers

Production server https://listingsapi.globalresolution.net
Development server http://localhost:8787

Authentication

The Listings API uses JWT (JSON Web Token) authentication. All protected endpoints require a valid access token in the Authorization header.

Getting an Access Token

Register a new account or login to receive an access token:

POST /auth/tokens
{
  "email": "[email protected]",
  "password": "your-password"
}

Response:
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh_token": "abc123...",
  "user": { ... }
}

Using the Access Token

Include the token in the Authorization header:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token Refresh

Access tokens expire after 1 hour. Use the refresh token to get a new access token:

POST /auth/tokens/refresh
{
  "refresh_token": "abc123..."
}

Error Codes

400 Bad Request

Invalid request parameters or malformed JSON

401 Unauthorized

Missing or invalid access token

403 Forbidden

Insufficient permissions for the requested resource

404 Not Found

Requested resource does not exist

422 Unprocessable Entity

Validation errors in request data

500 Internal Server Error

Server error - please try again later

Rate Limiting

The API implements rate limiting to ensure fair usage and prevent abuse.

Anonymous Requests

100 requests per minute

Authenticated Requests

1000 requests per minute

Rate limit headers are included in responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Code Examples

cURL

curl -H "Authorization: Bearer YOUR_TOKEN" https://listingsapi.globalresolution.net/listings

JavaScript (fetch)

const response = await fetch('https://listingsapi.globalresolution.net/listings', {
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
const data = await response.json();

Python (requests)

import requests
headers = {'Authorization': 'Bearer YOUR_TOKEN'}
response = requests.get('https://listingsapi.globalresolution.net/listings', headers=headers)
data = response.json()

Data Schemas

Listing Object

{
  "id": "string (UUID)",
  "title": "string",
  "description": "string",
  "price": "number",
  "currency": "string",
  "status": "active | inactive | sold",
  "created_at": "ISO 8601 timestamp",
  "updated_at": "ISO 8601 timestamp"
}

User Object

{
  "id": "string (UUID)",
  "uuid": "string (UUID)",
  "email": "string",
  "role": "admin | seller | buyer",
  "status": "active | inactive",
  "created_at": "ISO 8601 timestamp"
}

Changelog

v1.0.0 - Current

Initial release with full CRUD operations, authentication, search, analytics, and payment integration

Support

For support, questions, or bug reports, please contact:

https://github.com/your-repo/issues

API Policies

Terms of Use

  • API access is subject to rate limiting
  • Do not abuse the API or attempt to circumvent security measures
  • Respect user privacy and data protection regulations
  • API keys/tokens must be kept secure

Data Usage

  • Data retrieved from the API is for your application use only
  • Do not cache or redistribute data without authorization
  • Comply with applicable data protection laws (GDPR, CCPA, etc.)

Health Endpoints

Loading health endpoints...

Auth Endpoints

Loading auth endpoints...

Users Endpoints

Loading users endpoints...

Listings Endpoints

Loading listings endpoints...

Analytics Endpoints

Loading analytics endpoints...

Uploads Endpoints

Loading uploads endpoints...

Payments Endpoints

Loading payments endpoints...

Admin Endpoints

Loading admin endpoints...

Messages Endpoints

Loading messages endpoints...