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.
Overview
Public ProductThe 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.
Contact Us
Use the contact form to request access, report a bug, send a suggestion, or ask about integrating with the API.
Contact Item SwapsHealth Check
Confirms the API host can execute PHP and return JSON.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| None | - | No | This endpoint does not accept input. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| status | string | Health value. Expected ok. |
| service | string | Stable API service key. |
| timestamp_utc | datetime string | UTC response generation time. |
Sample Request
curl https://api.itemswaps.online/health.phpSample Response
{
"status": "ok",
"service": "item-swaps-api",
"domain": "api.itemswaps.online",
"version": "0.1.1"
}Version Metadata
Returns current public API version metadata.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| None | - | No | This endpoint does not accept input. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| api_version | string | Current API version. |
| service | string | Stable API service key. |
Sample Request
curl https://api.itemswaps.online/version.phpSample Response
{
"service": "item-swaps-api",
"api_version": "0.1.1"
}Get API Session Token
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
| Name | Type | Required | Description |
|---|---|---|---|
| client_key | string | Yes | Existing public client key issued during app client setup. |
| client_secret | string | Yes | Existing client secret from app client creation or rotation. |
| identity_token | string | No | Future signed user identity token from a supported login provider. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| api_session_token | string | Temporary bearer token for API calls. |
| expires_in_seconds | integer | Session lifetime. |
| environment | string | test 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"
}