The Prospya REST API.

Authentication

Create a key in Account → API and send it with every request:

Authorization: Bearer ld_your_key

GET /api/v1/search

Free. Same filters as the website: q (free text, e.g. "plumbers in lyon without website"), category, city, region, has_phone=1, has_email=1, has_instagram=1, has_website=0|1, rating_min, reviews_min, reviews_max, page. Contacts stay hidden until you unlock them.

curl -H "Authorization: Bearer $PROSPYA_KEY" \
  "https://prospya.com/api/v1/search?category=plumber&city=Lyon&has_email=1"

{"total": 38, "page": 1, "page_size": 25,
 "results": [{"id": 1042, "name": "…", "category": "Plumber", "city": "Lyon",
              "rating": 4.9, "has_phone": true, "has_email": true, "unlocked": false, …}]}

POST /api/v1/unlock

1 credit per business with a phone or an email, free if you already unlocked it. Up to 500 ids per call.

curl -X POST -H "Authorization: Bearer $PROSPYA_KEY" -H "Content-Type: application/json" \
  -d '{"ids": [1042, 1043]}' https://prospya.com/api/v1/unlock

{"credits_spent": 2, "credits": 23,
 "records": [{"id": 1042, "name": "…", "phone": "04 …", "email": "…", "website": "…", "unlocked": true, …}]}

GET /api/v1/me

Your email and credit balance.

Errors

401 invalid_api_key · 402 not_enough_credits · 400 no_ids. Need higher volumes? Contact us.