1
Sign Up & Get Your API Key
Create an account and generate your API key from the dashboard.
- Go to Sign Up and create your account
- Verify your email address
- Navigate to Dashboard → API Keys
- Click "Create New Key" and copy your API key
Important: Store your API key securely. It will only be shown once. Never commit it to version control.
2
Make Your First Request
Test your API key with a simple request to list development applications.
Using cURL
curl -X GET "https://api.councilapi.com.au/v1/applications?limit=5" \
-H "X-API-Key: YOUR_API_KEY"Using Python
import requests
response = requests.get(
"https://api.councilapi.com.au/v1/applications",
headers={"X-API-Key": "YOUR_API_KEY"},
params={"limit": 5}
)
data = response.json()
print(f"Found {data['total']} applications")Using JavaScript
const response = await fetch(
"https://api.councilapi.com.au/v1/applications?limit=5",
{
headers: { "X-API-Key": "YOUR_API_KEY" }
}
);
const data = await response.json();
console.log(`Found ${data.total} applications`);3
Filter by Council or Location
Narrow down results using filters like council, suburb, or status.
# Get applications in Sydney CBD under assessment
curl "https://api.councilapi.com.au/v1/applications" \
-H "X-API-Key: YOUR_API_KEY" \
-G \
-d "council=SYDNEY" \
-d "status=under_assessment" \
-d "suburb=Sydney"Common filters include: council, status, suburb, state, category, min_cost, max_cost
4
Handle Pagination
Results are paginated. Use page and per_page to navigate through results.
# Get page 2 with 100 results per page
curl "https://api.councilapi.com.au/v1/applications?page=2&per_page=100" \
-H "X-API-Key: YOUR_API_KEY"
# Response includes pagination info:
# {
# "data": [...],
# "total": 12500,
# "page": 2,
# "per_page": 100,
# "total_pages": 125
# }