Introduction

Overview

The PDAP API is how internal and external users programmatically access information and make changes to the PDAP Data Sources database.

Get access

Reach out to [e-mail] or make noise in Discord if you'd like access to the API.

See the administration page for information on user creation with the API.

Authentication

API routes that read and modify the Data Sources database should be protected through authentication. The API has an @api_required decorator (located in /middleware/security.py) that can be added to each route so that only authenticated users can access the database. To protect a route with this decorator, add @api_required on the line above a given route.

@api_required decorator

The @api_required decorator requires a request header to include an Authorization key with the value formatted as Bearer [jwt_token]. The api_required function parses the request header, decodes and extracts the API key, and checks to see if the api_key is defined. If it isn’t, it’ll return a message requesting an API key.

Validating the API key

If there is an API key, it’s passed to the is_valid function. This function connects to the Data Source database’s users table and finds the user in the table with the matching API key. The function then checks that a valid user was returned from the database. If not, the function returns False to api_required, which sends a response stating that the API key was invalid.

Rate limits

The rate limit for querying the database currently maxes out at 3000 rows, which is larger than the row count of any table in the database right now.

Examples

Python

Quick Search Data Sources

import requests
base_url = "https://data-sources.pdap.io/"
search_term = "review"  # Replace with your search term
location = "Pittsburgh"   # Replace with your desired location
api_key = "YOUR_API_KEY_HERE"  # Replace with your actual API key

url = f"{base_url}quick-search/{search_term}/{location}"

# Create the Authorization header
headers = {
    "Authorization": f"Bearer {api_key}"
}

# Make the GET request with the Authorization header
response = requests.get(url, headers=headers)

GET Agencies

import requests
base_url = "https://data-sources.pdap.io/"
api_key = "YOUR_API_KEY_HERE"  # Replace with your actual API key

url = f"{base_url}agencies"

# Create the Authorization header
headers = {
    "Authorization": f"Bearer {api_key}"
}

# Make the GET request with the Authorization header
response = requests.get(url, headers=headers)

JavaScript

Quick Search Data Sources

const axios = require('axios');

const baseUrl = "https://data-sources.pdap.io/";
const search_term = "review";  // Replace with your search term
const location = "Pittsburgh";    // Replace with your desired location
const api_key = "YOUR_API_KEY_HERE";  // Replace with your actual API key

const url = `${baseUrl}quick-search/${search_term}/${location}`;

// Create the Authorization header
const headers = {
  'Authorization': `Bearer ${api_key}`
};

// Make the GET request with the Authorization header
axios.get(url, { headers })
  .then(response => {
    console.log("Search results:");
    response.data.forEach(item => {
      console.log(`Data Source Name: ${item.name}`);
    });
  })
  .catch(error => {
      console.error("An error occurred:", error.message);
    }
  });

GET agencies

const axios = require('axios');

const baseUrl = "https://data-sources.pdap.io/";
const api_key = "YOUR_API_KEY_HERE";  // Replace with your actual API key

const url = `${baseUrl}agencies`;

// Create the Authorization header
const headers = {
  'Authorization': `Bearer ${api_key}`
};

// Make the GET request with the Authorization header
axios.get(url, { headers })
  .then(response => {
    console.log("Search results:");
    response.data.forEach(item => {
      console.log(`Agency: ${item.name}`);
    });
  })
  .catch(error => {
      console.error("An error occurred:", error.message);
    }
  });