The CARMA API provides REST-based access to data available on the CARMA site.
Use of the API does not require an API key, although CGD/CARMA reserves the right to limit or terminate access to the API at any time. If you make use of the API, we ask that you be polite and limit how often you make a direct call to the server and cache the result of API calls locally.
getPlant
id
(int), get a plant by its CARMA ID
name
(string), get a plant by name
getCompany
id
(int), get a company by its CARMA ID
name
(string), get a company by name
symbol
(string), get a company by its stock ticker symbol
color
(string), CARMA company color (green, blue, yellow, orange, red)
searchPlants
name
(string), search for plants by name
location
(int), search for plants by the location ID
operating_company
(int), search for plants by their operating company ID (company_id)
parent_company
(int), search for plants by their parent company ID (parentcomp_id)
zip
(int), search for plants by zip code (USA only)
color
(string), CARMA plant color (green, blue, yellow, orange, red)
limit
(int), Maximum number of rows returned (no limit:0, default:2000)
raw
(int), No filtering (raw=1&limit=0 to download ALL plants)
searchCompanies
name
(string), search for companies by name
location
(int), search for companies by the location ID (continent or country)
parent_company
(int), search for companies by their parent company ID (parentcomp_id)
color
(string), CARMA company color (green, blue, yellow, orange, red)
limit
(int), Maximum number of rows returned (no limit:0, default:100)
raw
(int), No filtering (raw=1&limit=0 to download ALL companies)
searchLocations
name
(string), search for locations or congressmen by name
region_type
(int), 1=continent, 2=country, 3=state, 4=metro, 5=county, 6=district, 7=city
color
(string), CARMA region color (green, blue, yellow, orange, red)
limit
(int), Maximum number of rows returned (no limit:0, default:100)
