For more advanced users

Create an Account

To use the CampShare API you must have a verified user account. It costs nothing and takes seconds so why not get started now?

Listings

GET: /locations/:location_id/categories/:category_id/listings?keywords=:keywords&filters=:filters

Search for listings given a location, category, keywords and/or filters.

Sample Request URL

/locations/37/categories/392/listings?keywords=netbook&filters=Condition,New;Type,Netbook%2FComputer

Sample Response

[{"title":"A cheap netbook for your campaign.","id":"23c6d2f0128bd31bb411e96640768282","posted_at":"2009-10-14 23:59:06"}]

GET: /locations/:location_id/categories/:category_id/listings

Get all active listings in a location and category. See the categories and locations sections to get their ids.

Sample Response

[{"title":"Porsche 911","id":"03705c93eb9a804e9858109e540ea5f5","posted_at":"2009-10-14 23:15:22"}, {"title":"1965 Austin Healey MKlll","id":"0518a1210db1342538db0df9e01af65b","posted_at":"2009-09-24 16:01:25"}, {"title":"this car is coolio","id":"e223d96a29b7502d6e2a7eded714711e","posted_at":"2009-09-22 22:37:26"}]

GET: /listings?ids=:ids

Get details for a set of listings specified by their ids.

Sample Request URL

/listings?ids=82a940b30d704cd0981a5d69ba11384a,1b8b9cbd40b88383402f0784eb5a196c,
fccd8d7f492a1c944295b4d8663fac51,1135213c86e28d4c699588e221290f08,
11da700e0482a6a7cf0a22b5a0044130

Sample Response

[{"meta_data":[{"name":"Condition", "value":"New"}, {"name":"Price", "value":"400"}, {"name":"Type", "value":"Netbook\/Computer"}], "category_id":"392", "location_id":"37", "images":[{"url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/Picture_2.png", "height":"228", "thumbnail_url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1376\/Picture_2_thumb.png", "width":"630"}, {"url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/Picture_4.png", "height":"266", "thumbnail_url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1379\/Picture_4_thumb.png", "width":"450"}, {"url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/Picture_6.png", "height":"273", "thumbnail_url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1382\/Picture_6_thumb.png", "width":"448"}], "category_name":"Electronics", "posted_at":"2009-10-14 00:54:19", "title":"A cheap netbook for your campaign.", "location_name":"SF Bay Area", "id":"82a940b30d704cd0981a5d69ba11384a", "expire_at":"2009-11-13 00:54:20", "description":"Dell's new 1st generation Netbook. Black, 16GB model. Yours to own now."}, {"meta_data":[{"name":"Price", "value":"0"}], "category_id":"380", "location_id":"37", "images":[], "category_name":"Arts and Crafts", "posted_at":"2009-10-09 01:11:28", "title":"gfdsg", "location_name":"SF Bay Area", "id":"1b8b9cbd40b88383402f0784eb5a196c", "expire_at":"2009-11-08 01:11:28", "description":"hgdf fdg 43erdf"}, {"meta_data":[{"name":"Price", "value":"30000"}], "category_id":"397", "location_id":"37", "images":[{"url":null, "height":"284", "thumbnail_url":null, "width":"419"}, {"url":null, "height":"281", "thumbnail_url":null, "width":"417"}, {"url":null, "height":"283", "thumbnail_url":null, "width":"419"}, {"url":null, "height":"276", "thumbnail_url":null, "width":"419"}, {"url":null, "height":"281", "thumbnail_url":null, "width":"418"}, {"url":null, "height":"280", "thumbnail_url":null, "width":"419"}], "category_name":"General", "posted_at":"2009-10-07 23:53:08", "title":"Escape the Doom and Gloom", "location_name":"SF Bay Area", "id":"fccd8d7f492a1c944295b4d8663fac51", "expire_at":"2009-11-06 23:53:08", "description":"With the stock markets crashing and the economy collapsing, what better way to deal than escape? This all inclusive trip to Australia includes a beach cottage for 6 months and pure bliss throughout the Australian summer."}, {"meta_data":[{"name":"Condition", "value":"Used"}, {"name":"Price", "value":"$20.00"}, {"name":"Type", "value":"Other"}], "category_id":"392", "location_id":"38", "images":[{"url":null, "height":"282", "thumbnail_url":null, "width":"630"}], "category_name":"Electronics", "posted_at":"2009-10-03 06:38:05", "title":"Sonic Bomb Alarm Clock", "location_name":"Alexandria", "id":"1135213c86e28d4c699588e221290f08", "expire_at":"2009-11-02 06:38:05", "description":"This barely used (only bought it last week) alarm clock goes up to 113 decibels and comes with a bed shaker to boot (you put it under your mattress and it violently shakes you awake). Only problem is that it doesn't keep time - it speeds up by about 15 minutes every hour. Still completely usable if you set your alarm to counter that. ThinkGeek sells it for $39.99 + shipping. I'll sell it for $20 pickup only."}, {"meta_data":[{"name":"Hourly Rate", "value":"0"}, {"name":"Type", "value":"Company"}], "category_id":"464", "location_id":"38", "images":[{"url":null, "height":"293", "thumbnail_url":null, "width":"391"}], "category_name":"Labor and Moving", "posted_at":"2009-10-02 18:51:00", "title":"Setup three tables in our office", "location_name":"Alexandria", "id":"11da700e0482a6a7cf0a22b5a0044130", "expire_at":"2009-11-01 18:51:00", "description":"We've got three IKEA tables (see photo) that need to be setup. We're in the financial district in Alexandria. You'll get $50 total for the three tables."}]

GET: /listings/:id

Get data on a specified listing.

Sample Response

{"images": [{ "url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/Picture_2.png", "height":"228", "thumbnail_url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1376\/Picture_2_thumb.png", "width":"630"}, { "url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/Picture_4.png", "height":"266", "thumbnail_url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1379\/Picture_4_thumb.png", "width":"450"}, { "url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/Picture_6.png", "height":"273", "thumbnail_url":"http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1382\/Picture_6_thumb.png", "width":"448"}], "meta_data":[ { "name":"Condition", "value":"New" }, { "name":"Price", "value":"299" }, { "name":"Type", "value":"Netbook\/Computer" }], "posted_at":"2009-10-14 00:54:19", "expire_at":"2009-11-13 00:54:20", "id":"82a940b30d704cd0981a5d69ba11384a", "category_id":"392", "category_name":"Electronics", "location_id":"37", "location_name":"Northern Virginia", "title":"A cheap netbook for your campaign.", "description":"Dell's new 1st generation Netbook. Black, 16GB model. Yours to own now."}

POST: /listings

Create a new listing on CampShare under your user account. Structure is similar to what is returned when you GET a listing. To find valid meta data name and value combinations see the categories section.

The request should consist of a JSON encoded string in a listing parameter.

Simple Sample Request

{"images": [{ "url":"http:\/\/myserver.com\/mypicture.png" }, { "url":"http:\/\/myserver.com\/mypicture2.png" }], "meta_data":[ { "name":"Condition", "value":"New" }, { "name":"Price", "value":"400" }, { "name":"Type", "value":"Netbook\/Computer" }], "category_id":"392", "location_id":"37", "title":"A cheap netbook for your campaign.", "description":"Dell's new 1st generation Netbook. Black, 16GB model. Yours to own now."}

Sample Response

{"id":"9942a1fccc757b354fb30e96c7759ef5"}

Categories

GET: /categories

Get a list of all categories.

Sample Response

[{"name":"Community","parent_name":null,"id":"364","parent_id":null}, {"name":"For Sale","parent_name":null,"id":"379","parent_id":null}, {"name":"For Donation","parent_name":null,"id":"379","parent_id":null}, {"name":"Housing","parent_name":null,"id":"409","parent_id":null}, {"name":"Jobs","parent_name":null,"id":"418","parent_id":null}, {"name":"Services","parent_name":null,"id":"455","parent_id":null}, {"name":"name","parent_name":null,"id":"363","parent_id":"362"}, {"name":"Activity Partners","parent_name":null,"id":"365","parent_id":"364"}, {"name":"General Community","parent_name":null,"id":"368","parent_id":"364"}, {"name":"Groups","parent_name":null,"id":"369","parent_id":"364"}, {"name":"Local News and Views","parent_name":null,"id":"370","parent_id":"364"}, {"name":"Politics","parent_name":null,"id":"374","parent_id":"364"}, {"name":"Rideshare","parent_name":null,"id":"375","parent_id":"364"}, {"name":"Volunteers","parent_name":null,"id":"376","parent_id":"364"}, {"name":"Classes","parent_name":null,"id":"377","parent_id":"364"}, {"name":"Events","parent_name":null,"id":"378","parent_id":"364"}, ...]

GET: /categories/:id

Get data on a category. Includes its name and available meta data.

Sample Response

{"name":"Electronics", "parent_name":"For Sale", "meta":[ {"name":"Condition", "default_value":null, "input_type":"select", "parent_name":null, "id":"2882", "select_options":"New, Used", "parent_id":null, "req_parent_value":null}, {"name":"Price", "default_value":"0", "input_type":"price", "parent_name":null, "id":"2880", "select_options":null, "parent_id":null, "req_parent_value":null}, {"name":"Type", "default_value":null, "input_type":"select", "parent_name":null, "id":"2881", "select_options":"Computer, Telephony, Network Equipment, Server Stuff, Furniture, Mobile Phones, GOTV, Office Supplies", "parent_id":null, "req_parent_value":null}], "id":"392"}

Users

GET: /users/:login

Get details about any registered CampShare user.

Sample Response

{ "created_at":"2009-08-2307:36:23", "total_listings_posted_by_friends":"200", "external_sites":["MySpace","Facebook","FriendFeed","Twitter"], "total_active_listings":"22", "total_listings_promoted":"11", "total_friends":"127", "locale":"en-US", "verified":"1", "total_owned_listings_promoted":"6", "total_listings_posted":"36", "login":"ben", "cs_vendor":"0", "first_name":"Ben" }

GET: /users/:login/listings

Get all active listings for a user.

Sample Response

[{"user": {"external_site_credentials": [ {"external_site": {"name": "MySpace"}}, {"external_site": {"name": "Facebook"}}, {"external_site": {"name": "FriendFeed"}}, {"external_site": {"name": "Twitter"}}], "login": "ben"}, "attachments": [ {"media_resource": {"s3_url": "http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1115\/Picture_4.png","name": null, "thumbnails": [{"s3_url": "http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1115\/Picture_4_small_avatar.png"}, {"s3_url": "http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1115\/Picture_4_thumb.png"}]}, "url": "http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1115\/Picture_4.png", "thumbnail_url": "http:\/\/s3.amazonaws.com\/cshare-primary\/media_resources\/1115\/Picture_4_small_avatar.png","caption": null}], "url": "\/locations\/38-san-francisco\/categories\/392-electronics\/listings\/sonic-bomb-alarm-clock--1135213c86e28d4c699588e221290f08", "title": "Sonic Bomb Alarm Clock", "category": {"name": "Electronics"}, "tiny_url": "http:\/\/cshare.com\/go\/cbg", "listing_category_metas": [ {"category_meta": {"name": "Price"},"value": "$20.00"}, {"category_meta": {"name": "Type"},"value": "Other"}, {"category_meta": {"name": "Condition"},"value": "Used"}], "promoters": [ {"user": {"external_site_credentials": [{"external_site": {"name": "Facebook"}}],"login": "teston"}}], "id_for_param": "sonic-bomb-alarm-clock--1135213c86e28d4c699588e221290f08", "description": "This barely used (only bought it last week) alarm clock goes up to 113 decibels and comes with a bed shaker to boot (you put it under your mattress and it violently shakes you awake). Only problem is that it doesn't keep time - it speeds up by about 15 minutes every hour. Still completely usable if you set your alarm to counter that. ThinkGeek sells it for $39.99 + shipping. I'll sell it for $20 pickup only.", "state": "Public", "location": {"name": "Alexandria"}, "posted_at": "2009/09/11 06:38:05 +0000", "expire_at": "2009/11/02 06:38:05 +0000"}, ...]

Locations

GET: /locations

Get a list of all locations in CampShare.

Sample Response

[{"name":"NEast","latitude":null,"path":null,"longitude":null}, {"name":"DC","latitude":"37.540778","path":"NEast","longitude":"-77.433928"}, {"name":"Richmond","latitude":"38.892091","path":"NEast","longitude":"-77.024055"}, {"name":"Charlottesville","latitude":"37.6965","path":"NEast","longitude":"-77.3458"}, {"name":"Hampton_Roads","latitude":"38.6875","path":"NEast","longitude":"-77.3509"}, {"name":"Roanoke","latitude":"37.501","path":"NEast","longitude":"-77.47677"}, {"name":"Raleigh_Durham","latitude":"32.2429","path":"NEast","longitude":"-77.3878"}, {"name":"Philadelphia","latitude":"32.3587","path":"NEast","longitude":"-77.5821"}, {"name":"BMore","latitude":"37.7052","path":"NEast","longitude":"-77.3411"}, ...]