Data API

Available API methods:
feed
pic
pic/like
pic/comment
user
user/follow
followers
following
place
city
collection
collection/pic


feed

Retrieves a pic_feed for the given arguments

URL:
http://api.picplz.com/api/v2/feed.json

Request Methods:
    GET

Requires Authentication:
    False* - for accessing the network feed you must be authenticated.

Required Arguments:
    type:  choices( interesting or network) type=interesting 

Optional Arguments:
    pic_formats: a comma separated list of image formats 
    pic_page_size:  max number of pics returned per page. default: 10

Example:

curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/feed.json?type=interesting' 

{
    "result": "ok",
    "value": {
        "more_pics": true,
        "last_pic_id": 153217,
        "pic_count": 200,
        "pics": [
            {
                "city": {
                    "url": "/city/san-francisco-ca/",
                    "id": 3,
                    "name": "San Francisco, CA"
                },
                "creator": {
                    "username": "waterbuffalo",
                    "display_name": "Waterbuffalo",
                    "following_count": 35,
                    "follower_count": 129,
                    "id": 1908,
                    "icon": {
                        "url": "/static/img/noicon.png",
                        "width": 100,
                        "height": 100
                    }
                },
                "url": "/user/waterbuffalo/pic/tx68/",
                "pic_files": {
                    "640r": {
                        "width": 640,
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_wmeg_00001.jpg",
                        "height": 480
                    },
                    "100sh": {
                        "width": 100,
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_t200s_00001.jpg",
                        "height": 100
                    },
                    "320rh": {
                        "width": 320,
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_mmed_00001.jpg",
                        "height": 240
                    }
                },
                "view_count": 44,
                "caption": "",
                "comment_count": 1,
                "like_count": 6,
                "place": {
                    "url": "/pics/academy-of-art-university-brannan-san-francisco-ca/",
                    "id": 30995,
                    "name": "Academy of Art University - Brannan"
                },
                "date": 1290540725,
                "id": 153982
            },
            [truncated]
        ]
    }
}






pic

Returns a list of pic or list of pics given the supplied parameters

URL:
    http://api.picplz.com/api/v2/pic.json

Request Methods:
    GET

Requires Authentication:
    False

Required Arguments:
One of:
    id or ids: A comma separated list of numeric pic IDs
    longurl_id or longurl_ids: A comma separated list of the identifier portion of "long" URLs (include only bolded portion):
        http://picplz.com/user/jenyasis/pic/f9x9/  --->  longurl_ids=f9x9
    shorturl_id or shorturl_ids: A comma separated list of the identifier portion of "short" URLs (include only bolded portion):
        http://picplz.com/nPhc   -----> shorturl_ids=nPhc 

Optional Arguments:
    include_items: It equal to 1 the response will include all comment items for the given pic id, if you pass multiple pic id's include_items will not work 
    
Examples:

Basic Example

curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/pic.json?id=153982'

{
    "result": "ok", 
    "value": {
        "pics": [
            {
                "city": {
                    "url": "/city/san-francisco-ca/", 
                    "id": 3, 
                    "name": "San Francisco, CA"
                }, 
                "creator": {
                    "username": "waterbuffalo", 
                    "display_name": "Waterbuffalo", 
                    "following_count": 36, 
                    "follower_count": 139, 
                    "id": 1908, 
                    "icon": {
                        "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png", 
                        "width": 100, 
                        "height": 100
                    }
                }, 
                "url": "/user/waterbuffalo/pic/tx68/", 
                "pic_files": {
                    "640r": {
                        "width": 640, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_wmeg_00001.jpg", 
                        "height": 480
                    }, 
                    "100sh": {
                        "width": 100, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_t200s_00001.jpg", 
                        "height": 100
                    }, 
                    "320rh": {
                        "width": 320, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_mmed_00001.jpg", 
                        "height": 240
                    }
                }, 
                "view_count": 47, 
                "caption": "", 
                "comment_count": 0, 
                "like_count": 6, 
                "place": {
                    "url": "/pics/academy-of-art-university-brannan-san-francisco-ca/", 
                    "id": 30995, 
                    "name": "Academy of Art University - Brannan"
                }, 
                "date": 1290540725, 
                "id": 153982
            }
        ]
    }
}

To include comments and likes pass include_items=1

curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/pic.json?id=153982&include_items=1'

{
    "result": "ok", 
    "value": {
        "pics": [
            {
                "city": {
                    "url": "/city/san-francisco-ca/", 
                    "id": 3, 
                    "name": "San Francisco, CA"
                }, 
                "creator": {
                    "username": "waterbuffalo", 
                    "display_name": "Waterbuffalo", 
                    "following_count": 36, 
                    "follower_count": 139,
                    "id": 1908, 
                    "icon": {
                        "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png", 
                        "width": 100, 
                        "height": 100
                    }
                }, 
                "url": "/user/waterbuffalo/pic/tx68/", 
                "pic_files": {
                    "640r": {
                        "width": 640, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_wmeg_00001.jpg", 
                        "height": 480
                    }, 
                    "100sh": {
                        "width": 100, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_t200s_00001.jpg", 
                        "height": 100
                    }, 
                    "320rh": {
                        "width": 320, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_mmed_00001.jpg", 
                        "height": 240
                    }
                }, 
                "view_count": 47, 
                "caption": "", 
                "comment_count": 0, 
                "like_count": 6, 
                "place": {
                    "url": "/pics/academy-of-art-university-brannan-san-francisco-ca/", 
                    "id": 30995, 
                    "name": "Academy of Art University - Brannan"
                }, 
                "items": [
                    {
                        "date": 1290541936, 
                        "recently_liked": [
                            {
                                "url": "/user/m24instudio/pic/3b2g/", 
                                "caption": "", 
                                "date": 1292875810, 
                                "id": 222723, 
                                "pic_files": {
                                    "640r": {
                                        "width": 640, 
                                        "img_url": "http://s0.i1.picplzthumbs.com/upload/img/51/22/08/5122080bb9b6304a7defa8083782355a62e4cce5_wmeg.jpg", 
                                        "height": 426
                                    }, 
                                    "100sh": {
                                        "width": 100, 
                                        "img_url": "http://s0.i1.picplzthumbs.com/upload/img/51/22/08/5122080bb9b6304a7defa8083782355a62e4cce5_t200s.jpg", 
                                        "height": 100
                                    }, 
                                    "320rh": {
                                        "width": 320, 
                                        "img_url": "http://s0.i1.picplzthumbs.com/upload/img/51/22/08/5122080bb9b6304a7defa8083782355a62e4cce5_mmed.jpg", 
                                        "height": 213
                                    }
                                }
                            },
                        "type": "like", 
                        "id": 21300, 
                        "user": {
                            "username": "djchandra",
                            "id": 76240, 
                            "icon": {
                                "url": "http://s1.ui1.picplzthumbs.com/usericons/54/e8/85/54e885449bb8c637f5266bd886d601e4a2077678_smal.jpg", 
                                "width": 35, 
                                "height": 35
                            }
                        }
                    },
                    
                    [truncated]
                ], 
                "date": 1290540725, 
                "id": 153982
            }
        ]
    }
}

To fetch information about multiple pics pass a comma separated list of pic ids, you can not get a list of comment items in a bulk pic call

 curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/pic.json?ids=153982,375945'

{
    "result": "ok", 
    "value": {
        "pics": [
            {
                "view_count": 29, 
                "creator": {
                    "username": "cutiecyber", 
                    "display_name": "cutiecyber", 
                    "following_count": 199, 
                    "follower_count": 118,
                    "id": 170266, 
                    "icon": {
                        "url": "http://s2.ui1.picplzthumbs.com/usericons/c6/fc/ca/c6fcca5a64d556656de9e130ba804fd72a5628e2_meds.jpg", 
                        "width": 75, 
                        "height": 75
                    }
                }, 
                "url": "/user/cutiecyber/pic/1zxv/", 
                "pic_files": {
                    "640r": {
                        "width": 383, 
                        "img_url": "http://s0.i1.picplzthumbs.com/upload/img/1d/f1/2b/1df12bda7cb826ebe10a04c00e58510908735656_wmeg_00001.jpg", 
                        "height": 640
                    }, 
                    "100sh": {
                        "width": 100, 
                        "img_url": "http://s0.i1.picplzthumbs.com/upload/img/1d/f1/2b/1df12bda7cb826ebe10a04c00e58510908735656_t200s_00001.jpg", 
                        "height": 100
                    }, 
                    "320rh": {
                        "width": 192, 
                        "img_url": "http://s0.i1.picplzthumbs.com/upload/img/1d/f1/2b/1df12bda7cb826ebe10a04c00e58510908735656_mmed_00001.jpg", 
                        "height": 320
                    }
                }, 
                "caption": "So and Sugar", 
                "comment_count": 0, 
                "like_count": 2, 
                "date": 1295363698, 
                "id": 375945
            }, 
            {
                "city": {
                    "url": "/city/san-francisco-ca/", 
                    "id": 3, 
                    "name": "San Francisco, CA"
                }, 
                "creator": {
                    "username": "waterbuffalo", 
                    "display_name": "Waterbuffalo", 
                    "following_count": 36, 
                    "follower_count": 139,
                    "id": 1908, 
                    "icon": {
                        "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png", 
                        "width": 100, 
                        "height": 100
                    }
                }, 
                "url": "/user/waterbuffalo/pic/tx68/", 
                "pic_files": {
                    "640r": {
                        "width": 640, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_wmeg_00001.jpg", 
                        "height": 480
                    }, 
                    "100sh": {
                        "width": 100, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_t200s_00001.jpg", 
                        "height": 100
                    }, 
                    "320rh": {
                        "width": 320, 
                        "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_mmed_00001.jpg", 
                        "height": 240
                    }
                }, 
                "view_count": 47, 
                "caption": "", 
                "comment_count": 0, 
                "like_count": 6, 
                "place": {
                    "url": "/pics/academy-of-art-university-brannan-san-francisco-ca/", 
                    "id": 30995, 
                    "name": "Academy of Art University - Brannan"
                }, 
                "date": 1290540725, 
                "id": 153982
            }
        ]
    }
}

If you want to know if an authenticated user has liked a pic or not make an authenticted call to get information about a pic

curl -H 'X-Pretty-JSON: 1' 'https://api.picplz.com/api/v2/pic.json?ids=153982
,375945&oauth_token=TOKEN'

{
    "result": "ok",
    "value": {
        "pics": [{
            "view_count": 111,
            "creator": {
                "username": "cutiecyber",
                "display_name": "cutiecyber",
                "following_count": 363,
                "is_you": false,
                "is_following": false,
                "follower_count": 261,
                "id": 170266,
                "icon": {
                    "url": "http://s2.ui1.picplzthumbs.com/usericons/c6/fc/ca/c6fcca5a64d556656de9e130ba804fd72a5628e2_meds.jpg",
                    "width": 75,
                    "height": 75
                }
            },
            "url": "/user/cutiecyber/pic/1zxv/",
            "pic_files": {
                "640r": {
                    "width": 383,
                    "img_url": "http://s0.i1.picplzthumbs.com/upload/img/1d/f1/2b/1df12bda7cb826ebe10a04c00e58510908735656_wmeg_00001.jpg",
                    "height": 640
                },
                "100sh": {
                    "width": 100,
                    "img_url": "http://s0.i1.picplzthumbs.com/upload/img/1d/f1/2b/1df12bda7cb826ebe10a04c00e58510908735656_t200s_00001.jpg",
                    "height": 100
                },
                "320rh": {
                    "width": 192,
                    "img_url": "http://s0.i1.picplzthumbs.com/upload/img/1d/f1/2b/1df12bda7cb826ebe10a04c00e58510908735656_mmed_00001.jpg",
                    "height": 320
                }
            },
            "you_like": false,
            "caption": "So and Sugar",
            "comment_count": 0,
            "like_count": 20,
            "date": 1295363698,
            "id": 375945
        },
        {
            "city": {
                "url": "/city/san-francisco-ca/",
                "id": 3,
                "name": "San Francisco, CA"
            },
            "creator": {
                "username": "waterbuffalo",
                "display_name": "Waterbuffalo",
                "following_count": 51,
                "is_you": false,
                "is_following": true,
                "follower_count": 192,
                "id": 1908,
                "icon": {
                    "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png",
                    "width": 100,
                    "height": 100
                }
            },
            "url": "/user/waterbuffalo/pic/tx68/",
            "pic_files": {
                "640r": {
                    "width": 640,
                    "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_wmeg_00001.jpg",
                    "height": 480
                },
                "100sh": {
                    "width": 100,
                    "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_t200s_00001.jpg",
                    "height": 100
                },
                "320rh": {
                    "width": 320,
                    "img_url": "http://s1.i1.picplzthumbs.com/upload/img/3a/06/06/3a0606dd770766a1120875009cc6711a0f494c23_mmed_00001.jpg",
                    "height": 240
                }
            },
            "view_count": 73,
            "you_like": false,
            "caption": "",
            "comment_count": 0,
            "like_count": 8,
            "place": {
                "url": "/pics/academy-of-art-university-brannan-san-francisco-ca/",
                "id": 30995,
                "name": "Academy of Art University - Brannan"
            },
            "date": 1290540725,
            "id": 153982
        }]
    }
}


pic/like

Likes or un-likes a pic

URL:
    https://api.picplz.com/api/v2/pic/like.json

Request Methods:
    POST, DELETE

Requires Authentication:
    True

Required Arguments:
One of:
    id: A single numeric pic IDs
    longurl_id: A single identifier portion of "long" URLs (include only bolded portion):
        http://picplz.com/user/jenyasis/pic/f9x9/  --->  longurl_id=f9x9
    shorturl_id: A single identifier portion of "short" URLs (include only bolded portion):
        http://picplz.com/nPhc   -----> shorturl_id=nPhc 
   
Examples:

curl -H 'X-Pretty-JSON: 1' -F id=1069999 -F oauth_token=TOKEN 'https://api.picplz.com/api/v2/pic/like.json'

{
    "result": "ok",
    "value": {
        "like": {
            "date": 1300500929,
            "type": "like",
            "id": 537273,
            "user": {
                "username": "bryan",
                "display_name": "Bryan B.",
                "id": 1
            }
        }
    }
}

curl -H 'X-Pretty-JSON: 1' -X DELETE 'https://api.picplz.com/api/v2/pic/like.json?id=1069999&oauth_token=TOKEN'



pic/comment

Post or delete a comment on a pic

URL:
    https://api.picplz.com/api/v2/pic/comment.json

Request Methods:
    POST, DELETE

Requires Authentication:
    True

Required Arguments:

When posting a comment:
    id: A single numeric pic IDs
  longurl_id: A single identifier portion of "long" URLs (include only bolded portion):
        http://picplz.com/user/jenyasis/pic/f9x9/  --->  longurl_id=f9x9
    shorturl_idA single identifier portion of "short" URLs (include only bolded portion):
        http://picplz.com/nPhc   -----> shorturl_id=nPhc
    comment: the text of the comment. 140 characters max, no links or HTML allowed

When deleting a comment:
    comment_id: A single numeric *comment* ID -- which you can get from the 'id' field on the items list on a pic as returned by the pic.json endpoint

Examples:

curl -H 'X-Pretty-JSON: 1' -F longurl_id=r05nl -F 'comment=hello world!' -F oauth_token=TOKEN 'https://api.picplz.com/api/v2/pic/comment.json'

{
    "result": "ok", 
    "value": {
        "comment": {
            "content": "hello world!", 
            "user": {
                "username": "bryan", 
                "display_name": "Bryan B.", 
                "id": 1
            }, 
            "can_delete": false, 
            "date": 1300860473, 
            "type": "comment", 
            "id": 68217
        }
    }
}

curl -H 'X-Pretty-JSON: 1' -X DELETE 'https://api.picplz.com/api/v2/pic/comment.json?comment_id=68217&oauth_token=TOKEN'




user

Returns info about a specific user given the supplied parameter

URL:
    http://api.picplz.com/api/v2/user.json

Request Methods:
    GET

Requires Authentication:
    False

Required Arguments:
    username or id: Pass either the username of the user, the user's id, or 'id=self' for the currently authenticated user

Optional Arguments:
     include_detail: If equal to 1 the response will include extra detail about a user
     include_pics: If equal to 1 the response will include a list of recent pictures from the user
     pic_page_size:  max number of pics returned per page. default: 10

Example:

      curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/user.json?id=self'
      curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/user.json?id=1908'
   curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/user.json?username=waterbuffalo'

{
    "result": "ok", 
    "value": {
        "users": [
            {
                "username": "waterbuffalo", 
                "display_name": "Waterbuffalo", 
                "following_count": 36, 
                "follower_count": 139, 
                "id": 1908, 
                "icon": {
                    "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png", 
                    "width": 100, 
                    "height": 100
                }
            }
        ]
    }
}

    To get information about multiple users you can pass multiple ids or usernames

      curl -H 'X-Pretty-JSON: 1' 'http://picplz.com/api/v2/user.json?ids=1908,170266'
   curl -H 'X-Pretty-JSON: 1' 'http://picplz.com/api/v2/user.json?usernames=waterbuffalo,cutiecyber'

    {
    "result": "ok", 
    "value": {
        "users": [
            {
                "username": "waterbuffalo", 
                "display_name": "Waterbuffalo", 
                "following_count": 36, 
                "follower_count": 139,
                "id": 1908, 
                "icon": {
                    "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png", 
                    "width": 100, 
                    "height": 100
                }
            }, 
            {
                "username": "cutiecyber", 
                "display_name": "cutiecyber", 
                "following_count": 199, 
                "follower_count": 119,
                "id": 170266, 
                "icon": {
                    "url": "http://s2.ui1.picplzthumbs.com/usericons/c6/fc/ca/c6fcca5a64d556656de9e130ba804fd72a5628e2_meds.jpg", 
                    "width": 75, 
                    "height": 75
                }
            }
        ]
    }
}


You can get detail about a user by passing the include_detail parameter

curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/user.json?username=waterbuffalo&include_detail=1'

{
    "result": "ok", 
    "value": {
        "users": [
            {
                "username": "waterbuffalo", 
                "place_count": 178, 
                "display_name": "Waterbuffalo", 
                "following_count": 36, 
                "follower_count": 139, 
                "id": 1908, 
                "icon": {
                    "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png", 
                    "width": 100, 
                    "height": 100
                }
            }
        ]
    }
}

You can get a list of recent pictures from the user by passing include_pics=1

curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/user.json?id=1908&include_pics=1'

{
    "result": "ok", 
    "value": {
        "users": [
            {
                "username": "waterbuffalo", 
                "last_pic_id": 372806, 
                "display_name": "Waterbuffalo", 
                "following_count": 36, 
                "pics": [
                    {
                        "city": {
                            "url": "/city/san-francisco-ca/", 
                            "id": 3, 
                            "name": "San Francisco, CA"
                        }, 
                        "creator": {
                            "username": "waterbuffalo", 
                            "id": 1908
                        }, 
                        "url": "/user/waterbuffalo/pic/1s95/", 
                        "pic_files": {
                            "640r": {
                                "width": 640, 
                                "img_url": "http://s2.i1.picplzthumbs.com/upload/img/83/68/41/8368418fd621aabbe4fddf065046390931ae5174_wmeg_00001.jpg", 
                                "height": 480
                            }, 
                            "100sh": {
                                "width": 100, 
                                "img_url": "http://s2.i1.picplzthumbs.com/upload/img/83/68/41/8368418fd621aabbe4fddf065046390931ae5174_t200s_00001.jpg", 
                                "height": 100
                            }, 
                            "320rh": {
                                "width": 320, 
                                "img_url": "http://s2.i1.picplzthumbs.com/upload/img/83/68/41/8368418fd621aabbe4fddf065046390931ae5174_mmed_00001.jpg", 
                                "height": 240
                            }
                        }, 
                        "view_count": 5, 
                        "caption": "", 
                        "comment_count": 0, 
                        "like_count": 2, 
                        "date": 1295373070, 
                        "id": 376523
                    }, 
                    [truncated]
                ], 
                "follower_count": 139, 
                "more_pics": true, 
                "pic_count": 676, 
                "id": 1908, 
                "icon": {
                    "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png", 
                    "width": 100, 
                    "height": 100
                }
            }
        ]
    }
}

To get information about wether or not a given user is following another user you can make an authenticated request on behalf of a user. 

curl -H 'X-Pretty-JSON: 1' 'https://api.picplz.com/api/v2/user.json?id=1908&oauth_token=TOKEN'

{
    "result": "ok",
    "value": {
        "users": [{
            "username": "waterbuffalo",
            "display_name": "Waterbuffalo",
            "following_count": 51,
            "is_you": false,
            "is_following": true,
            "follower_count": 192,
            "id": 1908,
            "icon": {
                "url": "http://a2.picplzthumbs.com/i/FwCNRNyPZJGlqJMyQXwM2wgQ_k4.png",
                "width": 100,
                "height": 100
            }
        }]
    }
}






user/follow


Will follow a user or stop following a user.

URL:
    http://api.picplz.com/api/v2/user/follow.json

Request Methods:
    POST, DELETE

Requires Authentication:
    True

Required Arguments:
    username or id: of the user who will be followed by the requesting user

Example:

    To follow a user you send a POST:
  curl -H 'X-Pretty-JSON: 1' -F id=2 -F oauth_token=ACCESS_TOKEN 'https://api.picplz.com/api/v2/user/follow.json'

{
    "result": "ok", 
    "value": {
        "users": [
            {
                "username": "bryan", 
                "display_name": "Bryan B.", 
                "id": 1
            }
        ]
    }
}

To stop following a user you can send a DELETE:

curl -H 'X-Pretty-JSON: 1' -X DELETE 'https://api.picplz.com/api/v2/user/follow.json?id=1&oauth_token=TOKEN'





followers

      curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/followers.json?id=self'
      curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/followers.json?id=1908'
      curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/followers.json?username=waterbuffalo'
Returns info about the users following a specific user

URL:
    http://api.picplz.com/api/v2/followers.json

Request Methods:
    GET

Requires Authentication:
    False

Required Arguments:
    username or id: Pass either the username of the user, the user's id, or 'id=self' for the currently authenticated user

Optional Arguments:
     include_user: If equal to 1 the response will include extra detail about a user
     page_size:  max number of followers returned per page. default: 10

Example:
curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/followers.json?username=bryan&include_user=1&page_size=2'

{
    "result": "ok", 
    "value": {
        "last_id": 16, 
        "requested_user": {
            "username": "bryan", 
            "display_name": "Bryan Berg", 
            "following_count": 200, 
            "pic_count": 605, 
            "follower_count": 234, 
            "id": 1, 
            "icon": {
                "url": "http://s2.ui1.picplzthumbs.com/usericons/78/ed/74/78ed744194ce83c769176e8a89c5d9f36a7a7146_meds.jpg", 
                "width": 75, 
                "height": 75
            }
        }, 
        "user_count": 234, 
        "users": [
            {
                "username": "dalton", 
                "display_name": "Dalton Caldwell", 
                "following_count": 346, 
                "follower_count": 1839, 
                "id": 2, 
                "icon": {
                    "url": "http://s0.ui1.picplzthumbs.com/usericons/2e/6f/5a/2e6f5aa2a99b4e7ff54afb7fdc3f0a2999b57d55_meds.jpg", 
                    "width": 75, 
                    "height": 75
                }
            }, 
            {
                "username": "allan", 
                "display_name": "Allan Hsu", 
                "following_count": 164, 
                "follower_count": 215, 
                "id": 3, 
                "icon": {
                    "url": "http://s1.ui1.picplzthumbs.com/usericons/67/5f/47/675f4790419868b9a1079e02c43335acc40cc722_meds.jpg", 
                    "width": 75, 
                    "height": 75
                }
            }
        ], 
        "more": true
    }
}




following

      curl -H 'X-Pretty-JSON: 1' 'https://api.picplz.com/api/v2/following.json?id=self'
      curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/following.json?id=1908'
      curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/following.json?username=waterbuffalo'
Returns info about who a specific user is following

URL:
    http://api.picplz.com/api/v2/following.json

Request Methods:
    GET

Requires Authentication:
    False

Required Arguments:
    username or id: Pass either the username of the user, the user's id, or 'id=self' for the currently authenticated user

Optional Arguments:
     include_user: If equal to 1 the response will include extra detail about a user
     page_size:  max number of followers returned per page. default: 10

Example:
curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/following.json?username=bryan&include_user=1&page_size=2'

{
    "result": "ok", 
    "value": {
        "last_id": 18, 
        "requested_user": {
            "username": "bryan", 
            "display_name": "Bryan Berg", 
            "following_count": 200, 
            "pic_count": 605, 
            "follower_count": 234, 
            "id": 1, 
            "icon": {
                "url": "http://s2.ui1.picplzthumbs.com/usericons/78/ed/74/78ed744194ce83c769176e8a89c5d9f36a7a7146_meds.jpg", 
                "width": 75, 
                "height": 75
            }
        }, 
        "user_count": 200, 
        "users": [
            {
                "username": "dalton", 
                "display_name": "Dalton Caldwell", 
                "following_count": 346, 
                "follower_count": 1839, 
                "id": 2, 
                "icon": {
                    "url": "http://s0.ui1.picplzthumbs.com/usericons/2e/6f/5a/2e6f5aa2a99b4e7ff54afb7fdc3f0a2999b57d55_meds.jpg", 
                    "width": 75, 
                    "height": 75
                }
            }, 
            {
                "username": "allan", 
                "display_name": "Allan Hsu", 
                "following_count": 164, 
                "follower_count": 215, 
                "id": 3, 
                "icon": {
                    "url": "http://s1.ui1.picplzthumbs.com/usericons/67/5f/47/675f4790419868b9a1079e02c43335acc40cc722_meds.jpg", 
                    "width": 75, 
                    "height": 75
                }
            }
        ], 
        "more": true
    }
}



place
 
Returns info about a specific place given the supplied parameter

URL:
    http://api.picplz.com/api/v2/place.json

Request Methods:
    GET

Requires Authentication:
    False

Required Arguments:
    id or ids: A comma separated list of numeric place IDs (as returned by other API calls)
    slug or slugs: A comma separated list of the identifier portion of place ("pics") URLs (include only bolded portion):
        http://picplz.com/pics/java-wallys-rochester-ny/  --->  slug=java-wallys-rochester-ny

Optional Arguments:
     include_detail: If equal to 1 the response will include extra detail about a user
     include_pics: If equal to 1 the response will include a list of recent pictures from the user
      pic_page_size:  max number of pics returned per page. default: 10

Example:

    curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/place.json?id=1'

      {
    "result": "ok", 
    "value": {
        "places": [
            {
                "url": "/pics/philz-coffee-san-francisco-ca/", 
                "id": 1, 
                "name": "Philz Coffee"
            }
        ]
    }
}


You can fetch more detail about a place by passing include_detail=1

curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/place.json?id=1&include_detail=1'

{
    "result": "ok", 
    "value": {
        "places": [
            {
                "name": "Philz Coffee", 
                "url": "/pics/philz-coffee-san-francisco-ca/", 
                "official_pic": {
                    "url": "/user/alexkatzen/pic/60tz/", 
                    "caption": "Mint Mojito Iced Coffee", 
                    "date": 1283375624, 
                    "id": 64977, 
                    "pic_files": {
                        "640r": {
                            "width": 478, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/d1/4a/d3/d14ad36da1a9219b7df477cc6f2b691278aefae3_wmeg.jpg", 
                            "height": 640
                        }, 
                        "100sh": {
                            "width": 100, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/d1/4a/d3/d14ad36da1a9219b7df477cc6f2b691278aefae3_t200s.jpg", 
                            "height": 100
                        }, 
                        "320rh": {
                            "width": 239, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/d1/4a/d3/d14ad36da1a9219b7df477cc6f2b691278aefae3_mmed.jpg", 
                            "height": 320
                        }
                    }
                }, 
                "pic_count": 13, 
                "id": 1, 
                "visitor_count": 5
            }
        ]
    }}

You can also fetch a list of pictures recently taken at a place by passing include_pics=1

curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/place.json?id=1&include_pics=1'

{
    "result": "ok", 
    "value": {
        "places": [
            {
                "name": "Philz Coffee", 
                "url": "/pics/philz-coffee-san-francisco-ca/", 
                "official_pic": {
                    "url": "/user/alexkatzen/pic/60tz/", 
                    "caption": "Mint Mojito Iced Coffee", 
                    "date": 1283375624, 
                    "id": 64977, 
                    "pic_files": {
                        "640r": {
                            "width": 478, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/d1/4a/d3/d14ad36da1a9219b7df477cc6f2b691278aefae3_wmeg.jpg", 
                            "height": 640
                        }, 
                        "100sh": {
                            "width": 100, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/d1/4a/d3/d14ad36da1a9219b7df477cc6f2b691278aefae3_t200s.jpg", 
                            "height": 100
                        }, 
                        "320rh": {
                            "width": 239, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/d1/4a/d3/d14ad36da1a9219b7df477cc6f2b691278aefae3_mmed.jpg", 
                            "height": 320
                        }
                    }
                }, 
                "pic_count": 13, 
                "id": 1, 
                "visitor_count": 5
            }
        ]
    }
}


curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/place.json?id=1&include_pics=1'

{
    "result": "ok", 
    "value": {
        "places": [
            {
                "last_pic_id": 64977, 
                "name": "Philz Coffee", 
                "url": "/pics/philz-coffee-san-francisco-ca/", 
                "pics": [
                    {
                        "view_count": 67, 
                        "creator": {
                            "username": "tim", 
                            "display_name": "Tim DeGraw", 
                            "following_count": 209, 
                            "follower_count": 189,
                            "id": 9, 
                            "icon": {
                                "url": "http://s1.ui1.picplzthumbs.com/usericons/c3/3a/60/c33a60cc8cf1f16acbd94aaaa2c43ff8bfc3b698_meds.jpg", 
                                "width": 75, 
                                "height": 75
                            }
                        }, 
                        "url": "/user/tim/pic/9s49/", 
                        "pic_files": {
                            "640r": {
                                "width": 478, 
                                "img_url": "http://s1.i1.picplzthumbs.com/upload/img/08/4a/97/084a97732e3c8784ddcf5087f7bdcb0997fcc538_wmeg_00001.jpg", 
                                "height": 640
                            }, 
                            "100sh": {
                                "width": 100, 
                                "img_url": "http://s1.i1.picplzthumbs.com/upload/img/08/4a/97/084a97732e3c8784ddcf5087f7bdcb0997fcc538_t200s_00001.jpg", 
                                "height": 100
                            }, 
                            "320rh": {
                                "width": 239, 
                                "img_url": "http://s1.i1.picplzthumbs.com/upload/img/08/4a/97/084a97732e3c8784ddcf5087f7bdcb0997fcc538_mmed_00001.jpg", 
                                "height": 320
                            }
                        }, 
                        "caption": "One cup at a time--for safety", 
                        "comment_count": 0, 
                        "like_count": 4, 
                        "place": {
                            "url": "/pics/philz-coffee-san-francisco-ca/", 
                            "id": 1, 
                            "name": "Philz Coffee"
                        }, 
                        "date": 1294110979, 
                        "id": 295960
                    }, 
                    [truncated]
                ], 
                "pic_count": 13, 
                "more_pics": true, 
                "id": 1
            }
        ]
    }
}


You can fetch information about multiple places by passing a comma separated list of place ids, or place slugs

curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/place.json?ids=1,2'

{
    "result": "ok", 
    "value": {
        "places": [
            {
                "url": "/pics/blue-bottle-coffee-ferry-building-san-francisco-ca/", 
                "id": 2, 
                "name": "Blue Bottle Coffee - Ferry Building"
            }, 
            {
                "url": "/pics/philz-coffee-san-francisco-ca/", 
                "id": 1, 
                "name": "Philz Coffee"
            }
        ]
    }}



city

Returns info about a specific city given the supplied parameter

URL:
http://api.picplz.com/api/v2/city.json

Request Methods:
GET

Requires Authentication:
False

Required Arguments:
One of:
    id or ids: A comma separated list of numeric city IDs (as returned by other API calls)
    slug or slugs: A comma separated list of the identifier portion of city URLs (include only bolded portion):
        http://picplz.com/city/san-francisco-ca/  --->  slug=san-francisco-ca

Optional Arguments:
     include_detail: If equal to 1 the response will include extra detail about a user
     include_pics: If equal to 1 the response will include a list of recent pictures from the user
     pic_page_size:  max number of pics returned per page. default: 10

Example:

            curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/city.json?id=3'
              
{
    "result": "ok", 
    "value": {
        "cities": [
            {
                "url": "/city/san-francisco-ca/", 
                "id": 3, 
                "name": "San Francisco, CA"
            }
        ]
    }
}

You can fetch more information about a city by passing include_detail=1

        curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/city.json?id=3&include_detail=1'
{
    "result": "ok", 
    "value": {
        "cities": [
            {
                "place_count": 1965, 
                "name": "San Francisco, CA", 
                "url": "/city/san-francisco-ca/", 
                "official_pic": {
                    "url": "/user/allan/pic/rdz0/", 
                    "caption": "", 
                    "date": 1281050211, 
                    "id": 45822, 
                    "pic_files": {
                        "640r": {
                            "width": 640, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/90/e6/0e/90e60e7404ecec7b492a73d791bdf2adad8beb05_wmeg.jpg", 
                            "height": 478
                        }, 
                        "100sh": {
                            "width": 100, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/90/e6/0e/90e60e7404ecec7b492a73d791bdf2adad8beb05_t200s.jpg", 
                            "height": 100
                        }, 
                        "320rh": {
                            "width": 320, 
                            "img_url": "http://s0.i1.picplzthumbs.com/upload/img/90/e6/0e/90e60e7404ecec7b492a73d791bdf2adad8beb05_mmed.jpg", 
                            "height": 239
                        }
                    }
                }, 
                "pic_count": 7480, 
                "id": 3, 
                "visitor_count": 730
            }
        ]
    }
}




You can get a list of pictures recently taken in a city by passing include_pics=1

        curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/city.json?id=3&include_pics=1'

        {
    "result": "ok", 
    "value": {
        "cities": [
            {
                "last_pic_id": 373191, 
                "name": "San Francisco, CA", 
                "url": "/city/san-francisco-ca/", 
                "pics": [
                    {
                        "view_count": 2, 
                        "creator": {
                            "username": "keithdkd", 
                            "display_name": "Keith Dreibelbis", 
                            "following_count": 23, 
                            "follower_count": 107, 
                            "id": 9820, 
                            "icon": {
                                "url": "http://s0.ui1.picplzthumbs.com/usericons/cb/c0/f5/cbc0f507f855dcb9159d3dbdba4b964f617b620f_meds.jpg", 
                                "width": 75, 
                                "height": 75
                            }
                        }, 
                        "url": "/user/keithdkd/pic/1sch/", 
                        "pic_files": {
                            "640r": {
                                "width": 480, 
                                "img_url": "http://s1.i1.picplzthumbs.com/upload/img/19/ad/fe/19adfe86c46fa2aa407a6aeea7872b18646dc081_wmeg.jpg", 
                                "height": 640
                            }, 
                            "100sh": {
                                "width": 100, 
                                "img_url": "http://s1.i1.picplzthumbs.com/upload/img/19/ad/fe/19adfe86c46fa2aa407a6aeea7872b18646dc081_t200s.jpg", 
                                "height": 100
                            }, 
                            "320rh": {
                                "width": 240, 
                                "img_url": "http://s1.i1.picplzthumbs.com/upload/img/19/ad/fe/19adfe86c46fa2aa407a6aeea7872b18646dc081_mmed.jpg", 
                                "height": 320
                            }
                        }, 
                        "caption": "", 
                        "comment_count": 0, 
                        "like_count": 1, 
                        "place": {
                            "url": "/pics/16th-st-mission-bart-san-francisco-ca/", 
                            "id": 4194, 
                            "name": "16th St Mission BART"
                        }, 
                        "date": 1295376014, 
                        "id": 376684
                    }, 
                    [truncated]
                "pic_count": 7480, 
                "more_pics": true, 
                "id": 3
            }
        ]
    }
}

You can get information about multiple cities in one call by passing a comma separated list of ids, or 

        curl -H 'X-Pretty-JSON: 1' 'http://api.picplz.com/api/v2/city.json?ids=1,3'

{
    "result": "ok", 
    "value": {
        "cities": [
            {
                "url": "/city/san-francisco-ca/", 
                "id": 3, 
                "name": "San Francisco, CA"
            }, 
            {
                "url": "/city/st-helena-ca/", 
                "id": 1, 
                "name": "St. Helena, CA"
            }
        ]
    }
}



collection

Fetches information about a collection or modifies the collection itself

URL:
    http://api.picplz.com/api/v2/collection.json

Request Methods:
    GET, POST, DELETE

Requires Authentication:
    True for write operations

Required Arguments:
    id: A single numeric collection ID (unless creating a new collection)
    
Optional Arguments:
     description: text description of the collection (when creating or updating only)
     include_pics: include pics in the collection (when fetching only)

Use GET to fetch a collection, including the pics inside of it.  Use POST to create a new collection or edit an existing collection (by passing in an 'id') and use DELETE to delete an existing collection.



collection

Adds or removes a pic from a collection

URL:
    https://api.picplz.com/api/v2/collection/pic.json

Request Methods:
    POST, DELETE

Requires Authentication:
    True

Required Arguments:
    id: A single numeric collection ID
    pic_id: A single numeric pic ID
    
Use POST to add a pic to a collection or DELETE to remove it.

Comments