AlterLabAPI Reference
Auto-generated
Listings
API reference for listings endpoints.
Auto-generated
This page was generated from the OpenAPI spec. Run
make generate-docs to refresh after spec changes.GET /api/v1/listings
GET
/api/v1/listingsSearch Listings
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | Optional | q |
| category | string | Optional | category |
| limit | integer | Optional | limitDefault: 20 |
| offset | integer | Optional | offsetDefault: 0 |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/listings \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"items": [],
"total": 0,
"limit": 0,
"offset": 0,
"next_action": "example"
}GET /api/v1/listings/feeds/{feed_id}/deltas
GET
/api/v1/listings/feeds/{feed_id}/deltasFeed Deltas
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| feed_id | string | Required | feed_id |
| page | integer | Optional | pageDefault: 1 |
| page_size | integer | Optional | page_sizeDefault: 20 |
| format | "json" | "ndjson" | Optional | formatDefault: json |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/listings/feeds/<feed_id>/deltas \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"feed_id": "example",
"page": 0,
"page_size": 0,
"total": 0,
"items": []
}GET /api/v1/listings/runs
GET
/api/v1/listings/runsList Listing Runs
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | Optional | limitDefault: 25 |
| offset | integer | Optional | offsetDefault: 0 |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/listings/runs \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"items": [],
"total": 0,
"limit": 0,
"offset": 0
}GET /api/v1/listings/runs/{run_id}
GET
/api/v1/listings/runs/{run_id}Get Listing Run
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| run_id | string | Required | run_id |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/listings/runs/<run_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"run_id": "example",
"slug": "example",
"version": "example",
"status": "example",
"valid_results": "example",
"billed_microcents": "example"
}GET /api/v1/listings/runs/{run_id}/results
GET
/api/v1/listings/runs/{run_id}/resultsGet Listing Run Results
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| run_id | string | Required | run_id |
| limit | integer | Optional | limitDefault: 100 |
| offset | integer | Optional | offsetDefault: 0 |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/listings/runs/<run_id>/results \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"run_id": "example",
"slug": "example",
"version": "example",
"status": "example",
"total": 0,
"limit": 0
}GET /api/v1/listings/{slug}
GET
/api/v1/listings/{slug}Get Listing
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
| version | string | Optional | version |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/listings/<slug> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"slug": "example",
"title": "example",
"summary": "example",
"category": "example",
"is_official": true,
"status": "example"
}POST /api/v1/listings/{slug}/feeds
POST
/api/v1/listings/{slug}/feedsCreate Listing Feed Endpoint
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
| input | object | Optional | Input |
| preset | string | Optional | preset |
| cron_expression | string | Optional | cron_expression |
| timezone | string | Optional | TimezoneDefault: UTC |
| webhook_url | string | Optional | webhook_url |
| delivery_mode | "delta" | "full" | Optional | delivery_mode |
| max_results | integer | Optional | max_results |
| monthly_cap_microcents | integer | Required | Monthly Cap Microcents |
| version | string | Optional | version |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/listings/<slug>/feeds \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"timezone": "example_timezone"
}'Response Example
JSON
{
"status": "ok"
}GET /api/v1/listings/{slug}/feeds
GET
/api/v1/listings/{slug}/feedsList Listing Feeds Endpoint
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/listings/<slug>/feeds \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"items": []
}GET /api/v1/listings/{slug}/feeds/{feed_id}
GET
/api/v1/listings/{slug}/feeds/{feed_id}Get Listing Feed Endpoint
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
| feed_id | string | Required | feed_id |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/listings/<slug>/feeds/<feed_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"slug": "example",
"version": "example",
"input": {},
"max_results": 0,
"cron_expression": "example"
}PATCH /api/v1/listings/{slug}/feeds/{feed_id}
PATCH
/api/v1/listings/{slug}/feeds/{feed_id}Update Listing Feed Endpoint
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
| feed_id | string | Required | feed_id |
| input | object | Optional | input |
| cron_expression | string | Optional | cron_expression |
| timezone | string | Optional | timezone |
| webhook_url | string | Optional | webhook_url |
| delivery_mode | "delta" | "full" | Optional | delivery_mode |
| max_results | integer | Optional | max_results |
| monthly_cap_microcents | integer | Optional | monthly_cap_microcents |
| status | "active" | "paused" | Optional | status |
Request Example
Bash
curl -X PATCH https://api.alterlab.io/api/v1/listings/<slug>/feeds/<feed_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"slug": "example",
"version": "example",
"input": {},
"max_results": 0,
"cron_expression": "example"
}DELETE /api/v1/listings/{slug}/feeds/{feed_id}
DELETE
/api/v1/listings/{slug}/feeds/{feed_id}Delete Listing Feed Endpoint
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
| feed_id | string | Required | feed_id |
Request Example
Bash
curl -X DELETE https://api.alterlab.io/api/v1/listings/<slug>/feeds/<feed_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"status": "ok"
}POST /api/v1/listings/{slug}/quote
POST
/api/v1/listings/{slug}/quoteQuote Listing Run
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
| max_results | integer | Optional | Max ResultsDefault: 100 |
| version | string | Optional | version |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/listings/<slug>/quote \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"max_results": 100
}'Response Example
JSON
{
"slug": "example",
"version": "example",
"max_results": 0,
"unit_microcents": 0,
"base_unit_microcents": 0,
"markup_unit_microcents": 0
}POST /api/v1/listings/{slug}/run
POST
/api/v1/listings/{slug}/runRun Listing
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | Required | slug |
| wait | boolean | Optional | waitDefault: False |
| version | string | Optional | version |
| input | object | Optional | Input |
| max_results | integer | Optional | Max ResultsDefault: 100 |
| sessions | object | Optional | Sessions |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/listings/<slug>/run \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"max_results": 100
}'Response Example
JSON
{
"run_id": "example",
"slug": "example",
"version": "example",
"status": "example",
"valid_results": "example",
"billed_microcents": "example"
}