API Platform

API documentation

Authentication, endpoint catalog, and webhook event contract for Civic Pulse APIs.

Authentication

Required header
Authorization: Bearer API_KEY
Accept: application/json

API key usage

Include your API key in the Authorization header for every request.

Rate limits

Requests are rate limited per key and return 429 Too Many Requests when the threshold is exceeded.

Endpoints

Pick an endpoint on the left to inspect the request, payload, and status details on the right.

GET

Federal Pulse API

200 OK

Top policy-stack ideas for the President.

Sample request
curl https://api.publicprimary.com/api/pulse/federal
  -H "Authorization: Bearer API_KEY"
  -H "Accept: application/json"
Sample response
{
  "status": "success",
  "status_code": 200,
  "message": "Data Found",
  "data": {
    "scope": "federal",
    "level": "federal",
    "prompt": "What should the President handle?",
    "ideas": [
      {
        "id": "money-prices",
        "title": "Money & Prices",
        "consensus": 84
      }
    ]
  }
}

Status codes

CodeMeaningDescription
200 OKSuccessful responseThe request completed successfully and returned a data payload.
400 Bad RequestInvalid requestThe query string, route parameter, or request format is invalid.
401 UnauthorizedAuthentication requiredThe API key is missing, invalid, or not permitted for this request.
404 Not FoundResource missingThe requested endpoint or resource does not exist.
429 Too Many RequestsRate limitedThe request rate has exceeded the allowed threshold for the API key.

Endpoint catalog

01GET
Federal Pulse API/api/pulse/federal
02GET
National Pulse API/api/pulse/national
03GET
State Senate Pulse API/api/pulse/state_leg_upper/{id}
04GET
State House Pulse API/api/pulse/state_leg_lower/{id}
05GET
Jurisdictions API/api/pulse/jurisdictions
06GET
States API/api/pulse/states
07GET
State Pulse API/api/pulse/state/{id}
08GET
District Pulse API/api/pulse/district/{id}
09GET
Idea Details API/api/pulse/idea/{id}
10GET
Trending Ideas API/api/pulse/trending
11GET
Categories API/api/pulse/categories
12GET
Historical Trends API/api/pulse/history
13GET
Velocity API/api/pulse/velocity
14GET
Demographics API/api/pulse/demographics
15GET
Risk API/api/pulse/risk
16GET
Search API/api/pulse/search?q=health