Documentation

API Documentation

RESTful API documentation for developers

Quick Info
Base URL
https://api.lots.directory
Authentication

API Key (Bearer token or X-API-Key header)

Total Endpoints

35

Getting Started

Authentication

All API requests require authentication using an API key. You can create an API key from your dashboard.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.lots.directory/api/v1/lotsdirectory/listings/ai-autofill

listings

POST
/api/v1/lotsdirectory/listings/ai-autofill

AI auto-fill from URL

autofill_listing

Scrape a product URL and generate a listing draft.

POST
/api/v1/lotsdirectory/images/uploads/complete

Complete product image upload

complete_listing_image_upload

Verify actual uploaded bytes and reserved size/type before attaching an image. Returns URL; at most 8 distinct images per listing including logo and cover.

POST
/api/v1/lotsdirectory/images/uploads

Create product image upload

create_listing_image_upload

Upload a local image: obtain a 15-minute signed PUT URL, upload bytes, then complete_listing_image_upload. Exact size, at most 2 MB. JPEG/PNG/WebP/GIF only.

POST
/api/v1/lotsdirectory/images/delete

Delete unused product image

delete_listing_image

Delete an uploaded image you own. Remove it from the listing and save first. Frees an unattached upload slot.

GET
/api/v1/lotsdirectory/listings/:id

Get my product

get_my_listing

Get full details of a listing you own (for editing).

GET
/api/v1/lotsdirectory/listings/:id/analytics

Get product analytics

get_listing_analytics

Read views, clicks, and a view-to-click ratio for a Directory Pro product you own. There is no source attribution. Free products receive PRO_REQUIRED.

POST
/api/v1/lotsdirectory/listings/import-ph

Import from Product Hunt

import_from_producthunt

Generate a listing draft from a Product Hunt post URL.

GET
/api/v1/lotsdirectory/me/listings

List my products

list_my_listings

List listings owned by the authenticated user.

POST
/api/v1/lotsdirectory/listings/:id/updates

Publish a product update

add_listing_update

Publish an update on a Directory Pro product you own. Free products cannot post updates. Questions stay free.

POST
/api/v1/lotsdirectory/listings

Submit a product

submit_listing

Create a product listing you own. publication: publish (default), draft to keep it private while preparing, or schedule with scheduled_publish_at. Free includes 2 distinct images, Directory Pro 8; logo, cover, gallery and thumbnails count once per URL; each image at most 2 MB.

PATCH
/api/v1/lotsdirectory/listings/:id

Update a product

update_listing

Update a product you own. A free product can keep a grandfathered image set only when the URLs do not change. Any real image change must fit 2 images, or 8 after Directory Pro. Do not send is_pro or an image limit; the server decides.

POST
/api/v1/lotsdirectory/images

Upload product image

upload_listing_image

Upload an image URL or base64 image to Directory storage. Maximum 2 MB, JPEG/PNG/WebP/GIF. Free products can use 2 distinct images and Directory Pro products can use 8, including logo and cover. The same URL counts once. Pass listing_id so the server enforces that product limit. At most 2 uploads may remain unattached.

POST
/api/v1/lotsdirectory/listings/:id/verify-badge

Verify backlink badge

verify_badge

Crawl a listing website and confirm the lots.directory badge backlink exists.

pro

POST
/api/v1/lotsdirectory/listings/:id/ai-review

AI content review

run_content_review

Score a product listing against the quality checklist. Requires the Pro pack.

POST
/api/v1/lotsdirectory/listings/:id/ai-rewrite

AI rewrite listing

ai_rewrite_listing

Generate improved tagline/description/about for a product. Returns proposed copy to apply. Requires the Pro pack.

GET
/api/v1/lotsdirectory/listings/:id/backlinks

Get earned backlinks

get_listing_backlinks

List published backlinks earned for a product and progress counts. Requires the Pro pack.

POST
/api/v1/lotsdirectory/listings/:id/landing-audit

Landing page audit

run_landing_audit

Audit a product landing page for conversion/quality. Requires the Pro pack.

GET
/api/v1/lotsdirectory/listings/:id/ai-reviews

List content reviews

list_content_reviews

List past AI content reviews for a product you own.

GET
/api/v1/lotsdirectory/listings/:id/landing-audits

List landing audits

list_landing_audits

List past landing page audits for a product you own.

engagement

PATCH
/api/v1/lotsdirectory/questions/:id

Answer a question

answer_question

Answer a question on a listing you own.

GET
/api/v1/lotsdirectory/me/questions

List incoming questions

list_owner_questions

List questions asked on your products (to answer).

GET
/api/v1/lotsdirectory/me/notifications

List notifications

list_notifications

List the authenticated user notifications.

POST
/api/v1/lotsdirectory/me/notifications/read

Mark notification read

mark_notification_read

Mark one or all notifications read.

read

GET
/api/v1/lotsdirectory/public/categories/:slug

Get category

get_category

Get a category with its published products.

GET
/api/v1/lotsdirectory/public/collections/:slug

Get collection

get_collection

Get a curated collection and its products by slug.

GET
/api/v1/lotsdirectory/public/makers/:username/listings

Get maker products

get_maker_listings

List all published products by a maker username.

GET
/api/v1/lotsdirectory/public/makers/:username

Get maker profile

get_maker

Get a maker profile by username.

GET
/api/v1/lotsdirectory/public/listings/:slug

Get product

get_listing

Get a single published product by slug.

GET
/api/v1/lotsdirectory/public/categories

List categories

list_categories

List all directory categories.

GET
/api/v1/lotsdirectory/public/collections

List collections

list_collections

List curated product collections (best-of, alternatives).

GET
/api/v1/lotsdirectory/public/listings

List products

list_listings

List published directory products with filters and sorting.

GET
/api/v1/lotsdirectory/public/tags

List tags

list_tags

List all tags used across the directory.

GET
/api/v1/lotsdirectory/public/search

Search products

search_listings

Typeahead search across published products.

profile

GET
/api/v1/lotsdirectory/me/profile

Get my profile

get_my_profile

Get the authenticated maker profile.

PATCH
/api/v1/lotsdirectory/me/profile

Update maker profile

update_profile

Update the authenticated user maker profile.