API by Example

This document is simply a list of working links using pplapi. Each link has a brief description and a link to the official API documentation. Try clicking the links to get a feeling for how they operate. Since the API is actually very simple, you can accomplish almost any task by modifying the examples in this document. See API Reference for the complete documentation.

JSON API

pplapi will provide responses as JSON, which can be helpful for integrating with JavaScript applications.

Purpose Example Documentation
Get one agent http://pplapi.com/6352373083.json Agent (JSON)
Get one agent at random http://pplapi.com/random.json Random Agent (JSON)
Get one agent at random from a Country http://pplapi.com/country/ca/random.json Random Agent from a Country (JSON)
Get a sample of 5 agents http://pplapi.com/batch/5/sample.json Sample from Agents (JSON)
Get a sample of 5 agents from a Country http://pplapi.com/batch/5/country/ca/sample.json Sample from Agents in a Country (JSON)
Get system metrics http://pplapi.com/metrics.json Metrics (JSON)

CSV API

pplapi will provide responses as Comma Separated Values (CSV), which is useful for statistics and scientific software.

Purpose Example Documentation
Get one agent http://pplapi.com/6352373083.csv Agent (CSV)
Get one agent at random http://pplapi.com/random.csv Random Agent (CSV)
Get one agent at random from a Country http://pplapi.com/country/ca/random.csv Random Agent from a Country (CSV)
Get a sample of 5 agents http://pplapi.com/batch/5/sample.csv Sample from Agents (CSV)
Get a sample of 5 agents from a Country http://pplapi.com/batch/5/country/ca/sample.csv Sample from Agents in a Country (CSV)
Get system metrics http://pplapi.com/metrics.csv Metrics (CSV)

Navigation


Related Topics