Item Swaps APIDeveloper portal for api.itemswaps.online

Early Access

Item Swaps API

Item Swaps helps approved community apps share information about reusable items, where they may be found, and whether they are currently reported as available.

Base URLapi.itemswaps.online
AudienceApproved apps
Use CaseCommunity sharing
AccessEarly access

Overview

Public Product

The Item Swaps API is intended for websites, mobile apps, and community tools that help people discover and maintain shared item availability at participating locations.

Supported experiences may include location browsing, item search, item availability summaries, and signed-in community updates where the calling app has been approved for access.

Access is currently limited while the product is being prepared for broader public use.

Contact Us

Use the contact form to request access, report a bug, send a suggestion, or ask about integrating with the API.

Contact Item Swaps

Health Check

GET /health.php
Live

Confirms the API host can execute PHP and return JSON.

Input Parameters

NameTypeRequiredDescription
None-NoThis endpoint does not accept input.

Output Parameters

NameTypeDescription
statusstringHealth value. Expected ok.
servicestringStable API service key.
timestamp_utcdatetime stringUTC response generation time.

Sample Request

curl https://api.itemswaps.online/health.php

Sample Response

{
  "status": "ok",
  "service": "item-swaps-api",
  "domain": "api.itemswaps.online",
  "version": "0.1.1"
}

Version Metadata

GET /version.php
Live

Returns current public API version metadata.

Input Parameters

NameTypeRequiredDescription
None-NoThis endpoint does not accept input.

Output Parameters

NameTypeDescription
api_versionstringCurrent API version.
servicestringStable API service key.

Sample Request

curl https://api.itemswaps.online/version.php

Sample Response

{
  "service": "item-swaps-api",
  "api_version": "0.1.1"
}

Get API Session Token

POST /v0.1.1/auth/session.php
Live

Exchanges an existing app client's key and secret for a temporary API session token. This endpoint does not create or change the app client.

Input Parameters

NameTypeRequiredDescription
client_keystringYesExisting public client key issued during app client setup.
client_secretstringYesExisting client secret from app client creation or rotation.
identity_tokenstringNoFuture signed user identity token from a supported login provider.

Output Parameters

NameTypeDescription
api_session_tokenstringTemporary bearer token for API calls.
expires_in_secondsintegerSession lifetime.
environmentstringtest or production.

Sample Request

{
  "client_key": "client_key",
  "client_secret": "one-time-secret"
}

Sample Response

{
  "api_session_token": "api-session-token",
  "expires_in_seconds": 3600,
  "environment": "test"
}
JSON Request TesterCurrent function
Paste JSON to validate it for this function.