{"_id":"576d42354bcd290e0042895a","category":{"_id":"576d42354bcd290e00428944","__v":0,"version":"576d42354bcd290e00428941","project":"56a526d4e7a1622b0024fae4","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-11T11:25:07.821Z","from_sync":false,"order":0,"slug":"objective-c","title":"Our API"},"__v":0,"project":"56a526d4e7a1622b0024fae4","user":"56bc6af27c91881900089bac","editedParams2":true,"version":{"_id":"576d42354bcd290e00428941","project":"56a526d4e7a1622b0024fae4","__v":1,"createdAt":"2016-06-24T14:22:45.076Z","releaseDate":"2016-06-24T14:22:45.076Z","categories":["576d42354bcd290e00428942","576d42354bcd290e00428943","576d42354bcd290e00428944","576d42354bcd290e00428945","576d42354bcd290e00428946","576d42354bcd290e00428947"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-11T11:31:07.721Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"56bc70fb9afb8b0d00d62dba","ref":"","in":"path","required":false,"desc":"The unique chirp identifier","default":"","type":"string","name":"identifier"}],"url":"/chirps/:identifier"},"isReference":true,"order":4,"body":"[block:textarea]\n{\n  \"text\": \"## Request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import requests\\n\\nurl = 'https://api.chirp.io/v1/chirps/parrotbill'\\nheaders = {\\n  'X-Auth-Token': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',\\n}\\n\\nresponse = requests.get(url, headers=headers)\",\n      \"language\": \"python\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"## Results\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"name\": 200,\n      \"code\": \"{\\n    \\\"longcode\\\": \\\"parrotbilllllahcm4\\\",\\n    \\\"created_at\\\": \\\"2012-11-28T15:17:18.255000\\\",\\n    \\\"shortcode\\\": \\\"parrotbill\\\",\\n    \\\"public\\\": true,\\n    \\\"data\\\": {\\n        \\\"mimetype\\\": \\\"image/jpeg\\\",\\n        \\\"url\\\": \\\"http://ibc.lynxeds.com/files/imagecache/photo_940/pictures/Golden_Parrotbill.jpg\\\",\\n        \\\"title\\\": \\\"Picture\\\"\\n    }\\n}\",\n      \"language\": \"json\",\n      \"status\": 200\n    },\n    {\n      \"name\": 400,\n      \"code\": \"{\\n    \\\"status\\\": 400,\\n    \\\"description\\\": \\\"Bad Request: Invalid parameter(s).\\\",\\n    \\\"error\\\": true\\n}\",\n      \"language\": \"json\",\n      \"status\": 400\n    },\n    {\n      \"code\": \"{\\n    \\\"status\\\": 401,\\n    \\\"description\\\": \\\"Unauthorized: Missing access token.\\\",\\n    \\\"error\\\": true\\n}\",\n      \"language\": \"json\",\n      \"status\": 401,\n      \"name\": 401\n    },\n    {\n      \"code\": \"{\\n    \\\"status\\\": 403,\\n    \\\"description\\\": \\\"Forbidden: Your token does not grant access to this resource.\\\",\\n    \\\"error\\\": true\\n}\",\n      \"language\": \"json\",\n      \"status\": 403,\n      \"name\": 403\n    },\n    {\n      \"code\": \"{\\n    \\\"status\\\": 404,\\n    \\\"description\\\": \\\"Not Found: Chirp not found.\\\",\\n    \\\"error\\\": true\\n}\",\n      \"language\": \"json\",\n      \"status\": 404,\n      \"name\": 404\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nRetrieve the contents of a chirp based on its unique `shortcode` identifier.\n\n* `longcode` is equal to the shortcode plus error-correction characters, used when broadcasting the chirp as audio.\n* `created_at` is the ISO-8601 date on which the chirp was created.\n* `public` indicates whether the chirp is visible to all applications, or just the application that created it.\n* `data` is an arbitrary JSON object.","excerpt":"Retrieve a chirp.","slug":"api-get-chirp","type":"endpoint","title":"/chirps/:identifier"}

get/chirps/:identifier

Retrieve a chirp.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

identifier:
string
The unique chirp identifier

Documentation

[block:textarea] { "text": "## Request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "import requests\n\nurl = 'https://api.chirp.io/v1/chirps/parrotbill'\nheaders = {\n 'X-Auth-Token': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',\n}\n\nresponse = requests.get(url, headers=headers)", "language": "python" } ], "sidebar": true } [/block] [block:textarea] { "text": "## Results", "sidebar": true } [/block] [block:code] { "codes": [ { "name": 200, "code": "{\n \"longcode\": \"parrotbilllllahcm4\",\n \"created_at\": \"2012-11-28T15:17:18.255000\",\n \"shortcode\": \"parrotbill\",\n \"public\": true,\n \"data\": {\n \"mimetype\": \"image/jpeg\",\n \"url\": \"http://ibc.lynxeds.com/files/imagecache/photo_940/pictures/Golden_Parrotbill.jpg\",\n \"title\": \"Picture\"\n }\n}", "language": "json", "status": 200 }, { "name": 400, "code": "{\n \"status\": 400,\n \"description\": \"Bad Request: Invalid parameter(s).\",\n \"error\": true\n}", "language": "json", "status": 400 }, { "code": "{\n \"status\": 401,\n \"description\": \"Unauthorized: Missing access token.\",\n \"error\": true\n}", "language": "json", "status": 401, "name": 401 }, { "code": "{\n \"status\": 403,\n \"description\": \"Forbidden: Your token does not grant access to this resource.\",\n \"error\": true\n}", "language": "json", "status": 403, "name": 403 }, { "code": "{\n \"status\": 404,\n \"description\": \"Not Found: Chirp not found.\",\n \"error\": true\n}", "language": "json", "status": 404, "name": 404 } ], "sidebar": true } [/block] Retrieve the contents of a chirp based on its unique `shortcode` identifier. * `longcode` is equal to the shortcode plus error-correction characters, used when broadcasting the chirp as audio. * `created_at` is the ISO-8601 date on which the chirp was created. * `public` indicates whether the chirp is visible to all applications, or just the application that created it. * `data` is an arbitrary JSON object.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}