Quick Start Guide
Get the ProcedureRadar API working in 5 minutes
Prerequisites
- ✓A ProcedureRadar account (free tier available)
- ✓Your API key (found in dashboard)
- ✓Basic knowledge of HTTP requests
- ✓A REST client (curl, Postman, or similar)
Step 1: Get Your API Key
- 1.Sign up or log in at procedureradar.com
- 2.Navigate to API Keys in your account settings
- 3.Click "Create New Key" and save it somewhere secure
Important: Keep your API key secret! Never commit it to version control or share it publicly.
Step 2: Make Your First Request
Let's start by fetching a list of procedures:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.procedureradar.com/v1/procedures?limit=5
https://api.procedureradar.com/v1/procedures?limit=5
Replace YOUR_API_KEY with your actual API key.
Step 3: Use an SDK (Recommended)
Using one of our official SDKs makes working with the API much easier. Choose your language:
JavaScript / TypeScript
Install the SDK:
npm install procedureradar
Use it in your code:
import { ProcedureRadar } from 'procedureradar';
const client = new ProcedureRadar('YOUR_API_KEY');
// Fetch procedures
const procedures = await client.procedures.list({
limit: 10
});
// Get pricing for a specific procedure
const pricing = await client.pricing.search({
procedureId: 'knee-replacement',
metro: 'new-york'
});
console.log(pricing);Python
Install the SDK:
pip install procedureradar
Use it in your code:
from procedureradar import ProcedureRadar
client = ProcedureRadar('YOUR_API_KEY')
# Fetch procedures
procedures = client.procedures.list(limit=10)
# Get pricing for a specific procedure
pricing = client.pricing.search(
procedure_id='knee-replacement',
metro='new-york'
)
print(pricing)Go
Install the SDK:
go get github.com/procedureradar/go-client
Use it in your code:
package main
import (
"fmt"
pr "github.com/procedureradar/go-client"
)
func main() {
client := pr.NewClient("YOUR_API_KEY")
// Fetch procedures
procs, err := client.Procedures.List(
&pr.ListOptions{Limit: 10})
// Get pricing
pricing, err := client.Pricing.Search(
&pr.PricingQuery{
ProcedureID: "knee-replacement",
Metro: "new-york",
})
fmt.Println(pricing)
}Common Tasks
Search for procedures
// JavaScript
const results = await client.procedures.list({
search: 'knee',
limit: 10
});Get pricing by location
// JavaScript
const pricing = await client.pricing.search({
procedureId: 'proc_123',
metro: 'san-francisco',
insurancePlan: 'aetna-blue'
});Compare hospital pricing
// JavaScript
const comparison = await client.pricing.compare({
procedureId: 'proc_123',
hospitalIds: ['hosp_1', 'hosp_2', 'hosp_3'],
metro: 'new-york'
});