API reference / Account
Send feedback
Written and maintained by The ProspectAPIs team
POST/v1/feedback
POST /v1/feedback is the ProspectAPIs operation sendFeedback, in the Account group of the REST API. Report a bug, a wrong or empty field, or a missing capability to the team. Free; at most 10 an hour per account. Cost: free, 10 an hour. Send your API key as a Bearer token in the Authorization header.
The quickstart shows this call in context, next to the first requests most integrations make.
Parameters
This operation takes no path or query parameters.
Request body
JSON (FeedbackRequest).
| Field | Type | Description |
|---|---|---|
| kind | string: bug, feature, question | Default "bug". |
| title required | string | At most 200 characters. |
| details required | string | At most 8000 characters. |
| tool | string | The tool or endpoint the report is about, e.g. research_get. At most 60 characters. |
{
"kind": "bug",
"title": "country filter ignores accents",
"details": "GET /v1/funding?country=Curaçao returned 0 records; expected 2."
}Responses
| Status | Meaning |
|---|---|
| 202 | The report was sent to the team. |
| 400 | The request was invalid (e.g. a bad filter or input); nothing was charged. |
| 401 | The API key is missing or invalid. |
| 429 | Too many requests; retry after the window. |
| 502 | The report could not be delivered to the team; retry shortly. |
| 503 | Feedback is not being accepted right now. |
Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.
202 response fields
The report was sent to the team. The body is a FeedbackAccepted.
| Field | Type | Description |
|---|---|---|
| feedback_id required | string (uuid) | |
| status required | string | sent. |
Code samples
Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.
curl -X POST https://api.prospectapis.com/v1/feedback \
-H "Authorization: Bearer $PROSPECTAPIS_KEY" \
-H "Content-Type: application/json" \
-d '{ "kind": "bug", "title": "country filter ignores accents", "details": "GET /v1/funding?country=Curaçao returned 0 records; expected 2." }'const res = await fetch("https://api.prospectapis.com/v1/feedback", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({
"kind": "bug",
"title": "country filter ignores accents",
"details": "GET /v1/funding?country=Curaçao returned 0 records; expected 2."
}),
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);import os, requests
res = requests.post(
"https://api.prospectapis.com/v1/feedback",
headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
json={
"kind": "bug",
"title": "country filter ignores accents",
"details": "GET /v1/funding?country=Curaçao returned 0 records; expected 2.",
},
timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)Billing
This call is free: it never spends credits or free records, so you can call it as often as the rate limit allows. Metered calls on the same key report your balance after each response in X-Credits-Remaining, and GET /v1/account shows it at any time.
Related
Previous operation: Account balance. Next operation: API version. Every operation, grouped by area, is on the API reference index.
Create a free account to get a key, then run the samples above with your own values (this call acts for real, so use real inputs).
Was this page helpful?