{"__v":50,"_id":"55232974e2de0a3500f0a2e5","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"The Cannabis Reports API currently provides access to an ever-growing list of over 30,000 [strains](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), [products](doc:product-object), [producers](doc:producer-object), [seed companies](doc:seed-company-object), and [dispensaries](doc:dispensary-object). \n\nWe do this using our [UCPC - Universal Cannabis Product Code](doc:ucpc-universal-cannabis-product-code) (UCPC) system designed specifically for the cannabis industry. Understanding how the UCPC is organized will help you navigate our vast database quickly.\n\nWe feel that information can be one of the most powerful forces in ensuring an open and free industry where everyone can thrive on an equal playing field. \n\nThat's why we're offering an API to let you build upon the years of work we've done to catalogue and organize the fast evolving cannabis industry. \n\nWe're adding more to the database every day. Start creating something with the connected cannabis community, today!\n\nhttps://www.cannabisreports.com\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5YAtxbzQRfOUGHT6gJvJ_tools.svg\",\n        \"tools.svg\",\n        \"0\",\n        \"0\",\n        \"#7c98b8\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Best Practices\"\n}\n[/block]\n1. Understanding the [UCPC system](doc:ucpc-universal-cannabis-product-code) \n2. Read the [Terms of Service](https://www.cannabisreports.com/api/terms) \n3. Create a [Free Account](https://www.cannabisreports.com/user/create)\n4. Request [API Credentials](https://www.cannabisreports.com/my/api)\n5. Proper Use of Your API Key: [Request Headers](doc:request-headers) and [Response Headers](doc:response-headers)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Get Started Immediately\"\n}\n[/block]\nTake a look at our [UCPC overview](doc:ucpc-universal-cannabis-product-code) to see how the Cannabis Reports database works.\n\nYou can begin making requests directly within this documentation to access the incredible amount of cannabis information available for each specific item. \n\nTry it out for yourself. Click [/edibles/:ucpc](doc:edibles-ucpc) and use the provided `string` to access information on the example cannabis edible.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request API Credentials\"\n}\n[/block]\nGetting API credentials is possible once you've [created a free user account](https://www.cannabisreports.com/user/create) at Cannabis Reports. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Automated API Keys\",\n  \"body\": \"We're working on a process for automatically signing up for the Cannabis Reports API. At the moment, you can [contact us](https://www.cannabisreports.com/contact-us) to request that one be generated for you.\"\n}\n[/block]\nYou can request an API key with higher rate limits for development purposes. When you are logged into your Cannabis Reports account, you can visit your settings page, or go to:\n\n[https://www.cannabisreports.com/my/api](https://www.cannabisreports.com/my/api)\n\nThere, you can find your API key, or information to request one.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"About Cannabis Reports\"\n}\n[/block]\nCannabis Reports is a technology company working hard to improve the relationship between cannabis and human beings through education, outreach, and technology.\n\nWe are a [small team](https://www.cannabisreports.com/about-us) creating tools and content for both the cannabis community and the cannabis industry. Our mission is to provide substantial technology for the growing cannabis industry to evolve on a foundation of accurate, unbiased cannabis information.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/wbJ5Ttv1RPKlCQNYwP4Q_idea_360.png\",\n        \"idea_360.png\",\n        \"300\",\n        \"300\",\n        \"#b0ad4d\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Contact Us\"\n}\n[/block]\nCannabis Reports is a group of humans who work hard to support the cannabis community. We want to make it easy for your voice to be heard, so we have real people responding to your questions and suggestions by email and phone. Please do not hesitate to reach out to us through our [contact page](https://www.cannabisreports.com/contact-us).","category":"55232973e2de0a3500f0a2e3","createdAt":"2015-04-07T00:48:52.509Z","excerpt":"Cannabis API for a Connected Community","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"the-cannabis-reports-api","sync_unique":"","title":"The Cannabis Reports API","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

The Cannabis Reports API

Cannabis API for a Connected Community

The Cannabis Reports API currently provides access to an ever-growing list of over 30,000 [strains](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), [products](doc:product-object), [producers](doc:producer-object), [seed companies](doc:seed-company-object), and [dispensaries](doc:dispensary-object). We do this using our [UCPC - Universal Cannabis Product Code](doc:ucpc-universal-cannabis-product-code) (UCPC) system designed specifically for the cannabis industry. Understanding how the UCPC is organized will help you navigate our vast database quickly. We feel that information can be one of the most powerful forces in ensuring an open and free industry where everyone can thrive on an equal playing field. That's why we're offering an API to let you build upon the years of work we've done to catalogue and organize the fast evolving cannabis industry. We're adding more to the database every day. Start creating something with the connected cannabis community, today! https://www.cannabisreports.com [block:image] { "images": [ { "image": [ "https://files.readme.io/5YAtxbzQRfOUGHT6gJvJ_tools.svg", "tools.svg", "0", "0", "#7c98b8", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Best Practices" } [/block] 1. Understanding the [UCPC system](doc:ucpc-universal-cannabis-product-code) 2. Read the [Terms of Service](https://www.cannabisreports.com/api/terms) 3. Create a [Free Account](https://www.cannabisreports.com/user/create) 4. Request [API Credentials](https://www.cannabisreports.com/my/api) 5. Proper Use of Your API Key: [Request Headers](doc:request-headers) and [Response Headers](doc:response-headers) [block:api-header] { "type": "basic", "title": "Get Started Immediately" } [/block] Take a look at our [UCPC overview](doc:ucpc-universal-cannabis-product-code) to see how the Cannabis Reports database works. You can begin making requests directly within this documentation to access the incredible amount of cannabis information available for each specific item. Try it out for yourself. Click [/edibles/:ucpc](doc:edibles-ucpc) and use the provided `string` to access information on the example cannabis edible. [block:api-header] { "type": "basic", "title": "Request API Credentials" } [/block] Getting API credentials is possible once you've [created a free user account](https://www.cannabisreports.com/user/create) at Cannabis Reports. [block:callout] { "type": "info", "title": "Automated API Keys", "body": "We're working on a process for automatically signing up for the Cannabis Reports API. At the moment, you can [contact us](https://www.cannabisreports.com/contact-us) to request that one be generated for you." } [/block] You can request an API key with higher rate limits for development purposes. When you are logged into your Cannabis Reports account, you can visit your settings page, or go to: [https://www.cannabisreports.com/my/api](https://www.cannabisreports.com/my/api) There, you can find your API key, or information to request one. [block:api-header] { "type": "basic", "title": "About Cannabis Reports" } [/block] Cannabis Reports is a technology company working hard to improve the relationship between cannabis and human beings through education, outreach, and technology. We are a [small team](https://www.cannabisreports.com/about-us) creating tools and content for both the cannabis community and the cannabis industry. Our mission is to provide substantial technology for the growing cannabis industry to evolve on a foundation of accurate, unbiased cannabis information. [block:image] { "images": [ { "image": [ "https://files.readme.io/wbJ5Ttv1RPKlCQNYwP4Q_idea_360.png", "idea_360.png", "300", "300", "#b0ad4d", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Contact Us" } [/block] Cannabis Reports is a group of humans who work hard to support the cannabis community. We want to make it easy for your voice to be heard, so we have real people responding to your questions and suggestions by email and phone. Please do not hesitate to reach out to us through our [contact page](https://www.cannabisreports.com/contact-us).
View all 61 endpoints
The Cannabis Reports API currently provides access to an ever-growing list of over 30,000 [strains](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), [products](doc:product-object), [producers](doc:producer-object), [seed companies](doc:seed-company-object), and [dispensaries](doc:dispensary-object). We do this using our [UCPC - Universal Cannabis Product Code](doc:ucpc-universal-cannabis-product-code) (UCPC) system designed specifically for the cannabis industry. Understanding how the UCPC is organized will help you navigate our vast database quickly. We feel that information can be one of the most powerful forces in ensuring an open and free industry where everyone can thrive on an equal playing field. That's why we're offering an API to let you build upon the years of work we've done to catalogue and organize the fast evolving cannabis industry. We're adding more to the database every day. Start creating something with the connected cannabis community, today! https://www.cannabisreports.com [block:image] { "images": [ { "image": [ "https://files.readme.io/5YAtxbzQRfOUGHT6gJvJ_tools.svg", "tools.svg", "0", "0", "#7c98b8", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Best Practices" } [/block] 1. Understanding the [UCPC system](doc:ucpc-universal-cannabis-product-code) 2. Read the [Terms of Service](https://www.cannabisreports.com/api/terms) 3. Create a [Free Account](https://www.cannabisreports.com/user/create) 4. Request [API Credentials](https://www.cannabisreports.com/my/api) 5. Proper Use of Your API Key: [Request Headers](doc:request-headers) and [Response Headers](doc:response-headers) [block:api-header] { "type": "basic", "title": "Get Started Immediately" } [/block] Take a look at our [UCPC overview](doc:ucpc-universal-cannabis-product-code) to see how the Cannabis Reports database works. You can begin making requests directly within this documentation to access the incredible amount of cannabis information available for each specific item. Try it out for yourself. Click [/edibles/:ucpc](doc:edibles-ucpc) and use the provided `string` to access information on the example cannabis edible. [block:api-header] { "type": "basic", "title": "Request API Credentials" } [/block] Getting API credentials is possible once you've [created a free user account](https://www.cannabisreports.com/user/create) at Cannabis Reports. [block:callout] { "type": "info", "title": "Automated API Keys", "body": "We're working on a process for automatically signing up for the Cannabis Reports API. At the moment, you can [contact us](https://www.cannabisreports.com/contact-us) to request that one be generated for you." } [/block] You can request an API key with higher rate limits for development purposes. When you are logged into your Cannabis Reports account, you can visit your settings page, or go to: [https://www.cannabisreports.com/my/api](https://www.cannabisreports.com/my/api) There, you can find your API key, or information to request one. [block:api-header] { "type": "basic", "title": "About Cannabis Reports" } [/block] Cannabis Reports is a technology company working hard to improve the relationship between cannabis and human beings through education, outreach, and technology. We are a [small team](https://www.cannabisreports.com/about-us) creating tools and content for both the cannabis community and the cannabis industry. Our mission is to provide substantial technology for the growing cannabis industry to evolve on a foundation of accurate, unbiased cannabis information. [block:image] { "images": [ { "image": [ "https://files.readme.io/wbJ5Ttv1RPKlCQNYwP4Q_idea_360.png", "idea_360.png", "300", "300", "#b0ad4d", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Contact Us" } [/block] Cannabis Reports is a group of humans who work hard to support the cannabis community. We want to make it easy for your voice to be heard, so we have real people responding to your questions and suggestions by email and phone. Please do not hesitate to reach out to us through our [contact page](https://www.cannabisreports.com/contact-us).
{"__v":24,"_id":"55280bd4be8cd72300a2b523","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis Reports offers a [REST API](doc:rest-api-basics) so you can explore data and start building tools for the connected cannabis industry. Getting started is as simple as getting a user account and generating an API key.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Constant Improvements\",\n  \"body\": \"The cannabis industry is always evolving. Our API is always being developed and improved upon. Check back here for updates on new features or important changes to the API.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Your API Key\"\n}\n[/block]\nGetting API credentials is possible once you've [created an account](https://www.cannabisreports.com/user/create) at Cannabis Reports. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Automated API Keys\",\n  \"body\": \"We're working on a process for automatically signing up for the Cannabis Reports API. At the moment, you can [contact us](https://www.cannabisreports.com/contact-us) to request that one be generated for you.\"\n}\n[/block]\nWhen you're logged in, you can visit your settings page or go to: \n\n[https://www.cannabisreports.com/my/api](https://www.cannabisreports.com/my/api)\n\nThere, you can find your API key or information to request one.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Using Your API Key\"\n}\n[/block]\n[Request Headers](doc:request-headers): For secure use of the API, make sure to include your API key in the headers for all of your requests.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Example\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"X-API-Key\",\n    \"0-3\": \"Your API key.\",\n    \"1-0\": \"\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"f2b56a96dfecec56c8b032a586a25214e1fe0998\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[Response Headers](doc:response-headers): The Cannabis Reports API provides additional data in responses that help developers monitor usage.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Unauthenticated API Requests\"\n}\n[/block]\nCannabis Reports offers the ability to explore the API in a limited capacity without an API key.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Unauthenticated API requests are currently rate-limited via IP address. They aren't suitable for production or development purposes. Please request an API key to further explore the Cannabis Reports API.\",\n  \"title\": \"Not Suitable for Development or Production\"\n}\n[/block]\nCannabis Reports offers the basic ability to browse the API before authenticating. This is useful for checking out the API in your browser, or for deciding whether you like the API before you use it.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.getJSON(\\\"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\\\", function() { \\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nWe also don't require accept headers for `Application/JSON` so you can check out the API in your browser too:\n\nhttps://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000","category":"55232973e2de0a3500f0a2e3","createdAt":"2015-04-10T17:43:48.906Z","excerpt":"How to start making requests to the Cannabis Reports API.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"getting-access","sync_unique":"","title":"Getting Access","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Getting Access

How to start making requests to the Cannabis Reports API.

Cannabis Reports offers a [REST API](doc:rest-api-basics) so you can explore data and start building tools for the connected cannabis industry. Getting started is as simple as getting a user account and generating an API key. [block:callout] { "type": "success", "title": "Constant Improvements", "body": "The cannabis industry is always evolving. Our API is always being developed and improved upon. Check back here for updates on new features or important changes to the API." } [/block] [block:api-header] { "type": "basic", "title": "Your API Key" } [/block] Getting API credentials is possible once you've [created an account](https://www.cannabisreports.com/user/create) at Cannabis Reports. [block:callout] { "type": "info", "title": "Automated API Keys", "body": "We're working on a process for automatically signing up for the Cannabis Reports API. At the moment, you can [contact us](https://www.cannabisreports.com/contact-us) to request that one be generated for you." } [/block] When you're logged in, you can visit your settings page or go to: [https://www.cannabisreports.com/my/api](https://www.cannabisreports.com/my/api) There, you can find your API key or information to request one. [block:api-header] { "type": "basic", "title": "Using Your API Key" } [/block] [Request Headers](doc:request-headers): For secure use of the API, make sure to include your API key in the headers for all of your requests. [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Type", "h-2": "Example", "h-3": "Description", "0-0": "X-API-Key", "0-3": "Your API key.", "1-0": "", "0-1": "`string`", "0-2": "f2b56a96dfecec56c8b032a586a25214e1fe0998" }, "cols": 4, "rows": 1 } [/block] [Response Headers](doc:response-headers): The Cannabis Reports API provides additional data in responses that help developers monitor usage. [block:api-header] { "type": "basic", "title": "Unauthenticated API Requests" } [/block] Cannabis Reports offers the ability to explore the API in a limited capacity without an API key. [block:callout] { "type": "warning", "body": "Unauthenticated API requests are currently rate-limited via IP address. They aren't suitable for production or development purposes. Please request an API key to further explore the Cannabis Reports API.", "title": "Not Suitable for Development or Production" } [/block] Cannabis Reports offers the basic ability to browse the API before authenticating. This is useful for checking out the API in your browser, or for deciding whether you like the API before you use it. [block:code] { "codes": [ { "code": "$.getJSON(\"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\", function() { \n console.log(data);\n});", "language": "javascript" } ] } [/block] We also don't require accept headers for `Application/JSON` so you can check out the API in your browser too: https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000
Cannabis Reports offers a [REST API](doc:rest-api-basics) so you can explore data and start building tools for the connected cannabis industry. Getting started is as simple as getting a user account and generating an API key. [block:callout] { "type": "success", "title": "Constant Improvements", "body": "The cannabis industry is always evolving. Our API is always being developed and improved upon. Check back here for updates on new features or important changes to the API." } [/block] [block:api-header] { "type": "basic", "title": "Your API Key" } [/block] Getting API credentials is possible once you've [created an account](https://www.cannabisreports.com/user/create) at Cannabis Reports. [block:callout] { "type": "info", "title": "Automated API Keys", "body": "We're working on a process for automatically signing up for the Cannabis Reports API. At the moment, you can [contact us](https://www.cannabisreports.com/contact-us) to request that one be generated for you." } [/block] When you're logged in, you can visit your settings page or go to: [https://www.cannabisreports.com/my/api](https://www.cannabisreports.com/my/api) There, you can find your API key or information to request one. [block:api-header] { "type": "basic", "title": "Using Your API Key" } [/block] [Request Headers](doc:request-headers): For secure use of the API, make sure to include your API key in the headers for all of your requests. [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Type", "h-2": "Example", "h-3": "Description", "0-0": "X-API-Key", "0-3": "Your API key.", "1-0": "", "0-1": "`string`", "0-2": "f2b56a96dfecec56c8b032a586a25214e1fe0998" }, "cols": 4, "rows": 1 } [/block] [Response Headers](doc:response-headers): The Cannabis Reports API provides additional data in responses that help developers monitor usage. [block:api-header] { "type": "basic", "title": "Unauthenticated API Requests" } [/block] Cannabis Reports offers the ability to explore the API in a limited capacity without an API key. [block:callout] { "type": "warning", "body": "Unauthenticated API requests are currently rate-limited via IP address. They aren't suitable for production or development purposes. Please request an API key to further explore the Cannabis Reports API.", "title": "Not Suitable for Development or Production" } [/block] Cannabis Reports offers the basic ability to browse the API before authenticating. This is useful for checking out the API in your browser, or for deciding whether you like the API before you use it. [block:code] { "codes": [ { "code": "$.getJSON(\"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\", function() { \n console.log(data);\n});", "language": "javascript" } ] } [/block] We also don't require accept headers for `Application/JSON` so you can check out the API in your browser too: https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000
{"__v":22,"_id":"552c50017820b80d00aa4f46","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis Reports offers a traditional REST (http://en.wikipedia.org/wiki/Representational_state_transfer) architecture for accessing our API.\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"HTTPS for Your Privacy and Security\",\n  \"body\": \"Just like every page we serve on the Cannabis Reports website, all API requests are performed over HTTPS.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Requests\"\n}\n[/block]\nWhen making a request to the API, be sure to include your API key in the [request header](doc:request-headers).\n\nAPI keys with higher rate limits are available upon request at https://www.cannabisreports.com/my/api\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Responses\"\n}\n[/block]\nOur server responds via JSON (http://en.wikipedia.org/wiki/JSON) for all requests.\n\nWe respond with appropriate HTTP status codes\n(http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) depending on how you utilize our API.\n\nWe utilize ETags (http://en.wikipedia.org/wiki/HTTP_ETag) to offer appropriate `304: Not Modified` headers to let you speed up how quickly we can respond to your application.\n\nWe provide information about your current rate limits via `X-RateLimit-*` [response headers](doc:response-headers).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"JSONP\"\n}\n[/block]\nThe Cannabis Reports API allows for incredibly flexibility and power by supporting JSONP through use of the optional `callback` argument. \n\nMore information about JSONP can be found here:\nhttps://en.wikipedia.org/wiki/JSONP\n\nInformation about how to make JSONP requests with jQuery can be found here:\nhttps://learn.jquery.com/ajax/working-with-jsonp/","category":"55232973e2de0a3500f0a2e3","createdAt":"2015-04-13T23:23:45.111Z","excerpt":"General information about how this works.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"rest-api-basics","sync_unique":"","title":"REST API Basics","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

REST API Basics

General information about how this works.

Cannabis Reports offers a traditional REST (http://en.wikipedia.org/wiki/Representational_state_transfer) architecture for accessing our API. [block:callout] { "type": "success", "title": "HTTPS for Your Privacy and Security", "body": "Just like every page we serve on the Cannabis Reports website, all API requests are performed over HTTPS." } [/block] [block:api-header] { "type": "basic", "title": "Requests" } [/block] When making a request to the API, be sure to include your API key in the [request header](doc:request-headers). API keys with higher rate limits are available upon request at https://www.cannabisreports.com/my/api [block:api-header] { "type": "basic", "title": "Responses" } [/block] Our server responds via JSON (http://en.wikipedia.org/wiki/JSON) for all requests. We respond with appropriate HTTP status codes (http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) depending on how you utilize our API. We utilize ETags (http://en.wikipedia.org/wiki/HTTP_ETag) to offer appropriate `304: Not Modified` headers to let you speed up how quickly we can respond to your application. We provide information about your current rate limits via `X-RateLimit-*` [response headers](doc:response-headers). [block:api-header] { "type": "basic", "title": "JSONP" } [/block] The Cannabis Reports API allows for incredibly flexibility and power by supporting JSONP through use of the optional `callback` argument. More information about JSONP can be found here: https://en.wikipedia.org/wiki/JSONP Information about how to make JSONP requests with jQuery can be found here: https://learn.jquery.com/ajax/working-with-jsonp/
Cannabis Reports offers a traditional REST (http://en.wikipedia.org/wiki/Representational_state_transfer) architecture for accessing our API. [block:callout] { "type": "success", "title": "HTTPS for Your Privacy and Security", "body": "Just like every page we serve on the Cannabis Reports website, all API requests are performed over HTTPS." } [/block] [block:api-header] { "type": "basic", "title": "Requests" } [/block] When making a request to the API, be sure to include your API key in the [request header](doc:request-headers). API keys with higher rate limits are available upon request at https://www.cannabisreports.com/my/api [block:api-header] { "type": "basic", "title": "Responses" } [/block] Our server responds via JSON (http://en.wikipedia.org/wiki/JSON) for all requests. We respond with appropriate HTTP status codes (http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) depending on how you utilize our API. We utilize ETags (http://en.wikipedia.org/wiki/HTTP_ETag) to offer appropriate `304: Not Modified` headers to let you speed up how quickly we can respond to your application. We provide information about your current rate limits via `X-RateLimit-*` [response headers](doc:response-headers). [block:api-header] { "type": "basic", "title": "JSONP" } [/block] The Cannabis Reports API allows for incredibly flexibility and power by supporting JSONP through use of the optional `callback` argument. More information about JSONP can be found here: https://en.wikipedia.org/wiki/JSONP Information about how to make JSONP requests with jQuery can be found here: https://learn.jquery.com/ajax/working-with-jsonp/
{"__v":4,"_id":"55b811547df9ce2f008dfa73","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Before you begin developing around the Cannabis Reports API, please read and understand our [Terms of Service](https://www.cannabisreports.com/api/terms).\n\nWe offer access to the Cannabis Reports database with three principles in mind:\n\n1. Respect our content\n2. Create, imagine and give feedback\n3. Evolve with us\n\nKeep in mind that our goal here at Cannabis Reports is to provide the foundation for accurate and accessible cannabis information. Content available through the API may be from product details from large companies, genetics from small farms, or public reviews from individual patients. We believe all this information should be treated with equal respect.\n\nCannabis Reports may set a quota of operations on API usage, although we will always promote the building of cool cannabis tools, and want new technologies to succeed. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/o1MHSgUS8qRghVDbXU0g_screenshot_2015-07-23_13.18.46_720.png\",\n        \"screenshot_2015-07-23_13.18.46_720.png\",\n        \"720\",\n        \"655\",\n        \"#3db1cd\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","category":"55232973e2de0a3500f0a2e3","createdAt":"2015-07-28T23:33:40.270Z","excerpt":"Agreement for using the Cannabis Reports API","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"terms-of-service","sync_unique":"","title":"Terms of Service","type":"basic","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Terms of Service

Agreement for using the Cannabis Reports API

Before you begin developing around the Cannabis Reports API, please read and understand our [Terms of Service](https://www.cannabisreports.com/api/terms). We offer access to the Cannabis Reports database with three principles in mind: 1. Respect our content 2. Create, imagine and give feedback 3. Evolve with us Keep in mind that our goal here at Cannabis Reports is to provide the foundation for accurate and accessible cannabis information. Content available through the API may be from product details from large companies, genetics from small farms, or public reviews from individual patients. We believe all this information should be treated with equal respect. Cannabis Reports may set a quota of operations on API usage, although we will always promote the building of cool cannabis tools, and want new technologies to succeed. [block:image] { "images": [ { "image": [ "https://files.readme.io/o1MHSgUS8qRghVDbXU0g_screenshot_2015-07-23_13.18.46_720.png", "screenshot_2015-07-23_13.18.46_720.png", "720", "655", "#3db1cd", "" ] } ] } [/block]
Before you begin developing around the Cannabis Reports API, please read and understand our [Terms of Service](https://www.cannabisreports.com/api/terms). We offer access to the Cannabis Reports database with three principles in mind: 1. Respect our content 2. Create, imagine and give feedback 3. Evolve with us Keep in mind that our goal here at Cannabis Reports is to provide the foundation for accurate and accessible cannabis information. Content available through the API may be from product details from large companies, genetics from small farms, or public reviews from individual patients. We believe all this information should be treated with equal respect. Cannabis Reports may set a quota of operations on API usage, although we will always promote the building of cool cannabis tools, and want new technologies to succeed. [block:image] { "images": [ { "image": [ "https://files.readme.io/o1MHSgUS8qRghVDbXU0g_screenshot_2015-07-23_13.18.46_720.png", "screenshot_2015-07-23_13.18.46_720.png", "720", "655", "#3db1cd", "" ] } ] } [/block]
{"__v":5,"_id":"5543ae1712245b1900ba08e3","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"API Limited to GET\",\n  \"body\": \"Currently, the Cannabis Reports API does not expose any public facing requests except for `GET`. If you'd like to inquire about adding to the database, please contact us.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Verb\",\n    \"0-0\": \"`GET`\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"Make a request for information.\",\n    \"1-0\": \"`POST`\",\n    \"1-1\": \"Store something.\",\n    \"2-0\": \"`PUT`\",\n    \"2-1\": \"Update something\",\n    \"3-0\": \"`DELETE`\",\n    \"3-1\": \"Delete something.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"5543fd0212245b1900ba0996","createdAt":"2015-05-01T16:47:19.160Z","excerpt":"Supported methods for the API.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"http-methods","sync_unique":"","title":"HTTP Methods","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

HTTP Methods

Supported methods for the API.

[block:callout] { "type": "info", "title": "API Limited to GET", "body": "Currently, the Cannabis Reports API does not expose any public facing requests except for `GET`. If you'd like to inquire about adding to the database, please contact us." } [/block] [block:parameters] { "data": { "h-0": "Verb", "0-0": "`GET`", "h-1": "Description", "0-1": "Make a request for information.", "1-0": "`POST`", "1-1": "Store something.", "2-0": "`PUT`", "2-1": "Update something", "3-0": "`DELETE`", "3-1": "Delete something." }, "cols": 2, "rows": 4 } [/block]
[block:callout] { "type": "info", "title": "API Limited to GET", "body": "Currently, the Cannabis Reports API does not expose any public facing requests except for `GET`. If you'd like to inquire about adding to the database, please contact us." } [/block] [block:parameters] { "data": { "h-0": "Verb", "0-0": "`GET`", "h-1": "Description", "0-1": "Make a request for information.", "1-0": "`POST`", "1-1": "Store something.", "2-0": "`PUT`", "2-1": "Update something", "3-0": "`DELETE`", "3-1": "Delete something." }, "cols": 2, "rows": 4 } [/block]
{"__v":2,"_id":"5543fc75795b590d001dc9fb","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"The Cannabis Reports API responds with a variety of possible HTTP status codes depending on what you are requesting from the API.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Text\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`200`\",\n    \"0-1\": \"OK\",\n    \"0-2\": \"Successful request and response.\",\n    \"1-0\": \"`304`\",\n    \"1-1\": \"Not Modified\",\n    \"1-2\": \"This resource has not been modified since last requested.\",\n    \"4-0\": \"`403`\",\n    \"4-1\": \"Forbidden\",\n    \"4-2\": \"Access to this is not allowed with your credentials.\",\n    \"5-0\": \"`404`\",\n    \"5-1\": \"Not Found\",\n    \"5-2\": \"Resource or endpoint could not be found.\",\n    \"7-0\": \"`500`\",\n    \"7-1\": \"Internal Server Error\",\n    \"7-2\": \"Our server encountered an error processing your request.\",\n    \"6-0\": \"`429`\",\n    \"6-1\": \"Too Many Requests\",\n    \"6-2\": \"You have made more requests than your limits allow.\",\n    \"3-0\": \"`401`\",\n    \"3-1\": \"Not Authorized\",\n    \"3-2\": \"You are not authorized to do what you requested.\",\n    \"2-0\": \"`400`\",\n    \"2-1\": \"Bad Request\",\n    \"2-2\": \"Your request contained bad information.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","category":"5543fd0212245b1900ba0996","createdAt":"2015-05-01T22:21:41.574Z","excerpt":"The various status codes you can expect in HTTP responses from the API.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"http-status-codes","sync_unique":"","title":"HTTP Status Codes","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

HTTP Status Codes

The various status codes you can expect in HTTP responses from the API.

The Cannabis Reports API responds with a variety of possible HTTP status codes depending on what you are requesting from the API. [block:parameters] { "data": { "h-0": "Code", "h-1": "Text", "h-2": "Description", "0-0": "`200`", "0-1": "OK", "0-2": "Successful request and response.", "1-0": "`304`", "1-1": "Not Modified", "1-2": "This resource has not been modified since last requested.", "4-0": "`403`", "4-1": "Forbidden", "4-2": "Access to this is not allowed with your credentials.", "5-0": "`404`", "5-1": "Not Found", "5-2": "Resource or endpoint could not be found.", "7-0": "`500`", "7-1": "Internal Server Error", "7-2": "Our server encountered an error processing your request.", "6-0": "`429`", "6-1": "Too Many Requests", "6-2": "You have made more requests than your limits allow.", "3-0": "`401`", "3-1": "Not Authorized", "3-2": "You are not authorized to do what you requested.", "2-0": "`400`", "2-1": "Bad Request", "2-2": "Your request contained bad information." }, "cols": 3, "rows": 8 } [/block]
The Cannabis Reports API responds with a variety of possible HTTP status codes depending on what you are requesting from the API. [block:parameters] { "data": { "h-0": "Code", "h-1": "Text", "h-2": "Description", "0-0": "`200`", "0-1": "OK", "0-2": "Successful request and response.", "1-0": "`304`", "1-1": "Not Modified", "1-2": "This resource has not been modified since last requested.", "4-0": "`403`", "4-1": "Forbidden", "4-2": "Access to this is not allowed with your credentials.", "5-0": "`404`", "5-1": "Not Found", "5-2": "Resource or endpoint could not be found.", "7-0": "`500`", "7-1": "Internal Server Error", "7-2": "Our server encountered an error processing your request.", "6-0": "`429`", "6-1": "Too Many Requests", "6-2": "You have made more requests than your limits allow.", "3-0": "`401`", "3-1": "Not Authorized", "3-2": "You are not authorized to do what you requested.", "2-0": "`400`", "2-1": "Bad Request", "2-2": "Your request contained bad information." }, "cols": 3, "rows": 8 } [/block]
{"__v":2,"_id":"5543fcc062b30e0d004b1830","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Requests to the API are regular HTTP requests with a required header containing your API key and an optional header for handling ETags, If-None-Match.\n\nWhen receiving a successful [response](doc:response-headers) from the API, we will provide an ETag header. You can use this to ask the server whether the response for your request has actually changed. If it hasn't, then you will receive an appropriate `304: Not Modified` response and should handle it appropriately.\n\nMore information about ETags can be found in their Wikipedia entry:\n\nhttp://en.wikipedia.org/wiki/HTTP_ETag\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"X-API-Key\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"f2b56a96dfecec56c8b032a586a25214e1fe0998\",\n    \"1-0\": \"If-None-Match\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"\\\"489890ff27274daecd77864834d227cd\\\"\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Your API key.\",\n    \"1-3\": \"*(Optional)* - Server will respond with a `304: Not Modified` when it finds a matching response for your ETag.\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]","category":"5543fd0212245b1900ba0996","createdAt":"2015-05-01T22:22:56.954Z","excerpt":"Request headers for use in the API.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"request-headers","sync_unique":"","title":"Request Headers","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Request Headers

Request headers for use in the API.

Requests to the API are regular HTTP requests with a required header containing your API key and an optional header for handling ETags, If-None-Match. When receiving a successful [response](doc:response-headers) from the API, we will provide an ETag header. You can use this to ask the server whether the response for your request has actually changed. If it hasn't, then you will receive an appropriate `304: Not Modified` response and should handle it appropriately. More information about ETags can be found in their Wikipedia entry: http://en.wikipedia.org/wiki/HTTP_ETag [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Type", "h-2": "Example", "0-0": "X-API-Key", "0-1": "`string`", "0-2": "f2b56a96dfecec56c8b032a586a25214e1fe0998", "1-0": "If-None-Match", "1-1": "`string`", "1-2": "\"489890ff27274daecd77864834d227cd\"", "h-3": "Description", "0-3": "Your API key.", "1-3": "*(Optional)* - Server will respond with a `304: Not Modified` when it finds a matching response for your ETag." }, "cols": 4, "rows": 2 } [/block]
Requests to the API are regular HTTP requests with a required header containing your API key and an optional header for handling ETags, If-None-Match. When receiving a successful [response](doc:response-headers) from the API, we will provide an ETag header. You can use this to ask the server whether the response for your request has actually changed. If it hasn't, then you will receive an appropriate `304: Not Modified` response and should handle it appropriately. More information about ETags can be found in their Wikipedia entry: http://en.wikipedia.org/wiki/HTTP_ETag [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Type", "h-2": "Example", "0-0": "X-API-Key", "0-1": "`string`", "0-2": "f2b56a96dfecec56c8b032a586a25214e1fe0998", "1-0": "If-None-Match", "1-1": "`string`", "1-2": "\"489890ff27274daecd77864834d227cd\"", "h-3": "Description", "0-3": "Your API key.", "1-3": "*(Optional)* - Server will respond with a `304: Not Modified` when it finds a matching response for your ETag." }, "cols": 4, "rows": 2 } [/block]
{"__v":1,"_id":"5543fce462b30e0d004b1832","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"The Cannabis Reports API provides some additional data in responses that can help developers with their own needs.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"Content-Type\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"application/json\",\n    \"1-0\": \"ETag\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"\\\"489890ff27274daecd77864834d227cd\\\"\",\n    \"2-0\": \"X-RateLimit-Limit\",\n    \"2-1\": \"`integer`\",\n    \"2-2\": \"25\",\n    \"3-0\": \"X-RateLimit-Remaining\",\n    \"3-1\": \"`integer`\",\n    \"3-2\": \"19\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Our API speaks JSON so expect this header.\",\n    \"1-3\": \"The ETag for this request. Send this value along in an `If-None-Match` header with your request to see if the response has changed. If it hasn't, we will respond with a `304: Not Modified` instead of the regular `200: OK`.\",\n    \"2-3\": \"The number of requests you can make per every 15 minutes. Exceed this limit and you will get a `429: Too Many Requests` response until your limit has reset.\",\n    \"3-3\": \"The number of requests you have left in your 15 minute window.\",\n    \"4-0\": \"X-RateLimit-Reset\",\n    \"4-1\": \"`integer`\",\n    \"4-2\": \"1429129339\",\n    \"4-3\": \"Unix Timestamp for when your rate limit will reset.\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]","category":"5543fd0212245b1900ba0996","createdAt":"2015-05-01T22:23:32.895Z","excerpt":"Headers to expect in responses from the API.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"response-headers","sync_unique":"","title":"Response Headers","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Response Headers

Headers to expect in responses from the API.

The Cannabis Reports API provides some additional data in responses that can help developers with their own needs. [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Type", "h-2": "Example", "0-0": "Content-Type", "0-1": "`string`", "0-2": "application/json", "1-0": "ETag", "1-1": "`string`", "1-2": "\"489890ff27274daecd77864834d227cd\"", "2-0": "X-RateLimit-Limit", "2-1": "`integer`", "2-2": "25", "3-0": "X-RateLimit-Remaining", "3-1": "`integer`", "3-2": "19", "h-3": "Description", "0-3": "Our API speaks JSON so expect this header.", "1-3": "The ETag for this request. Send this value along in an `If-None-Match` header with your request to see if the response has changed. If it hasn't, we will respond with a `304: Not Modified` instead of the regular `200: OK`.", "2-3": "The number of requests you can make per every 15 minutes. Exceed this limit and you will get a `429: Too Many Requests` response until your limit has reset.", "3-3": "The number of requests you have left in your 15 minute window.", "4-0": "X-RateLimit-Reset", "4-1": "`integer`", "4-2": "1429129339", "4-3": "Unix Timestamp for when your rate limit will reset." }, "cols": 4, "rows": 5 } [/block]
The Cannabis Reports API provides some additional data in responses that can help developers with their own needs. [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Type", "h-2": "Example", "0-0": "Content-Type", "0-1": "`string`", "0-2": "application/json", "1-0": "ETag", "1-1": "`string`", "1-2": "\"489890ff27274daecd77864834d227cd\"", "2-0": "X-RateLimit-Limit", "2-1": "`integer`", "2-2": "25", "3-0": "X-RateLimit-Remaining", "3-1": "`integer`", "3-2": "19", "h-3": "Description", "0-3": "Our API speaks JSON so expect this header.", "1-3": "The ETag for this request. Send this value along in an `If-None-Match` header with your request to see if the response has changed. If it hasn't, we will respond with a `304: Not Modified` instead of the regular `200: OK`.", "2-3": "The number of requests you can make per every 15 minutes. Exceed this limit and you will get a `429: Too Many Requests` response until your limit has reset.", "3-3": "The number of requests you have left in your 15 minute window.", "4-0": "X-RateLimit-Reset", "4-1": "`integer`", "4-2": "1429129339", "4-3": "Unix Timestamp for when your rate limit will reset." }, "cols": 4, "rows": 5 } [/block]
{"__v":4,"_id":"5543ff3312245b1900ba099b","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"body":"The JSON that you get back from API responses will have some things that are useful for developers as well.\n\nIn case of a non-successful response, your JSON will have a \"message\" and \"status_code\" key.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"message\\\": \\\"An error message with information about what went wrong.\\\",\\n    \\\"status_code\\\": 400\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nSuccessful responses contain a \"data\" key, which will contain the data for your response. This may contain an array of objects, a single object, or other types of data.\n\nAdditionally, an optional \"meta\" key which might contain [pagination](doc:pagination) data.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"data\\\": [\\n        { ... }\\n    ],\\n    \\\"meta\\\": {\\n        \\\"pagination\\\": {          \\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5543fd0212245b1900ba0996","createdAt":"2015-05-01T22:33:23.322Z","excerpt":"Explanation of the JSON structure of our responses.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55232972e2de0a3500f0a2df","slug":"json-structure","sync_unique":"","title":"JSON Structure","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

JSON Structure

Explanation of the JSON structure of our responses.

The JSON that you get back from API responses will have some things that are useful for developers as well. In case of a non-successful response, your JSON will have a "message" and "status_code" key. [block:code] { "codes": [ { "code": "{\n \"message\": \"An error message with information about what went wrong.\",\n \"status_code\": 400\n}", "language": "json" } ] } [/block] Successful responses contain a "data" key, which will contain the data for your response. This may contain an array of objects, a single object, or other types of data. Additionally, an optional "meta" key which might contain [pagination](doc:pagination) data. [block:code] { "codes": [ { "code": "{\n \"data\": [\n { ... }\n ],\n \"meta\": {\n \"pagination\": { \n }\n }\n}", "language": "json" } ], "sidebar": true } [/block]
The JSON that you get back from API responses will have some things that are useful for developers as well. In case of a non-successful response, your JSON will have a "message" and "status_code" key. [block:code] { "codes": [ { "code": "{\n \"message\": \"An error message with information about what went wrong.\",\n \"status_code\": 400\n}", "language": "json" } ] } [/block] Successful responses contain a "data" key, which will contain the data for your response. This may contain an array of objects, a single object, or other types of data. Additionally, an optional "meta" key which might contain [pagination](doc:pagination) data. [block:code] { "codes": [ { "code": "{\n \"data\": [\n { ... }\n ],\n \"meta\": {\n \"pagination\": { \n }\n }\n}", "language": "json" } ], "sidebar": true } [/block]
{"__v":3,"_id":"5543ff70795b590d001dca04","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"pagination\\\": {\\n    \\\"total\\\": 4329,\\n    \\\"count\\\": 10,\\n    \\\"per_page\\\": 10,\\n    \\\"current_page\\\": 1,\\n    \\\"total_pages\\\": 433,\\n    \\\"links\\\": {\\n        \\\"next\\\": \\\"http://www.cannabisreports.com/api/v1.0/strains?page=2\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\nThere are a number of useful fields you may find regarding pagination for your requests if there are paginated results available.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Pagination Key\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"total\",\n    \"0-1\": \"`int`\",\n    \"0-2\": \"The total number of available items.\",\n    \"1-0\": \"count\",\n    \"1-1\": \"`int`\",\n    \"1-2\": \"Number of items in this response.\",\n    \"2-0\": \"per_page\",\n    \"2-1\": \"`int`\",\n    \"2-2\": \"Maximum number of items per paged response.\",\n    \"3-0\": \"current_page\",\n    \"3-1\": \"`int`\",\n    \"3-2\": \"The page you are currently on.\",\n    \"4-0\": \"total_pages\",\n    \"4-1\": \"`int`\",\n    \"4-2\": \"The total number of pages available.\",\n    \"5-0\": \"links\",\n    \"5-1\": \"`object`\",\n    \"5-2\": \"Links to access other pages for this request in the API. Contains a \\\"next\\\" and/or \\\"previous\\\" key.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","category":"5543fd0212245b1900ba0996","createdAt":"2015-05-01T22:34:24.956Z","excerpt":"How pagination works with the API.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55232972e2de0a3500f0a2df","slug":"pagination","sync_unique":"","title":"Pagination","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Pagination

How pagination works with the API.

[block:code] { "codes": [ { "code": "\"pagination\": {\n \"total\": 4329,\n \"count\": 10,\n \"per_page\": 10,\n \"current_page\": 1,\n \"total_pages\": 433,\n \"links\": {\n \"next\": \"http://www.cannabisreports.com/api/v1.0/strains?page=2\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] There are a number of useful fields you may find regarding pagination for your requests if there are paginated results available. [block:parameters] { "data": { "h-0": "Pagination Key", "h-1": "Type", "h-2": "Description", "0-0": "total", "0-1": "`int`", "0-2": "The total number of available items.", "1-0": "count", "1-1": "`int`", "1-2": "Number of items in this response.", "2-0": "per_page", "2-1": "`int`", "2-2": "Maximum number of items per paged response.", "3-0": "current_page", "3-1": "`int`", "3-2": "The page you are currently on.", "4-0": "total_pages", "4-1": "`int`", "4-2": "The total number of pages available.", "5-0": "links", "5-1": "`object`", "5-2": "Links to access other pages for this request in the API. Contains a \"next\" and/or \"previous\" key." }, "cols": 3, "rows": 6 } [/block]
[block:code] { "codes": [ { "code": "\"pagination\": {\n \"total\": 4329,\n \"count\": 10,\n \"per_page\": 10,\n \"current_page\": 1,\n \"total_pages\": 433,\n \"links\": {\n \"next\": \"http://www.cannabisreports.com/api/v1.0/strains?page=2\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] There are a number of useful fields you may find regarding pagination for your requests if there are paginated results available. [block:parameters] { "data": { "h-0": "Pagination Key", "h-1": "Type", "h-2": "Description", "0-0": "total", "0-1": "`int`", "0-2": "The total number of available items.", "1-0": "count", "1-1": "`int`", "1-2": "Number of items in this response.", "2-0": "per_page", "2-1": "`int`", "2-2": "Maximum number of items per paged response.", "3-0": "current_page", "3-1": "`int`", "3-2": "The page you are currently on.", "4-0": "total_pages", "4-1": "`int`", "4-2": "The total number of pages available.", "5-0": "links", "5-1": "`object`", "5-2": "Links to access other pages for this request in the API. Contains a \"next\" and/or \"previous\" key." }, "cols": 3, "rows": 6 } [/block]
{"__v":24,"_id":"5543f60f12245b1900ba097e","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis Reports developed the UCPC system to allow for intricate tracking and linking of products throughout the cannabis industry. It's like a [UPC](http://en.wikipedia.org/wiki/Universal_Product_Code) for cannabis.\n\nSince a UCPC is unique and forever tied to a product, it's safe to use for labelling and lets consumers get access to detailed information about their products. Here's a video of it in action:\n[block:html]\n{\n  \"html\": \"<iframe src=\\\"https://player.vimeo.com/video/122031315\\\" width=\\\"400\\\" height=\\\"224\\\" frameborder=\\\"0\\\" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>\"\n}\n[/block]\nDeveloped with industry professionals, the UCPC system allows for identification and tracking of products with consumer identification at the forefront. We created the UCPC system with a few goals and problems in mind:\n\n1. People deserve better ways to get accurate information about what they are consuming.\n2. The hundreds of thousands of people in the cottage cannabis industry deserve to be represented at all levels of tracking.\n3. Over the years, cannabis strain names have be re-used by various seed companies so the name alone is not enough.\n4. The product code should not just be random digits, but allow for learned identification purposes for consumers, producers and retailers, or for protection in cases of recalls for health concerns.\n5. The product code should have business usage in mind and not include characters or digits that are hard to read when hand-written, or hard to understand when spoken.\n\nWhen using the Cannabis Reports API, you'll be able to identify individual [strains](doc:strains), [extracts](doc:extracts), [edibles](doc:edibles), [products](doc:products), [producers](doc:producers), and [seed companies](doc:seed-company-object) using their unique UCPC codes.","category":"5543f5c8795b590d001dc9f1","createdAt":"2015-05-01T21:54:23.785Z","excerpt":"Information about the identification system we use at Cannabis Reports.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"ucpc-universal-cannabis-product-code","sync_unique":"","title":"UCPC - Universal Cannabis Product Code","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

UCPC - Universal Cannabis Product Code

Information about the identification system we use at Cannabis Reports.

Cannabis Reports developed the UCPC system to allow for intricate tracking and linking of products throughout the cannabis industry. It's like a [UPC](http://en.wikipedia.org/wiki/Universal_Product_Code) for cannabis. Since a UCPC is unique and forever tied to a product, it's safe to use for labelling and lets consumers get access to detailed information about their products. Here's a video of it in action: [block:html] { "html": "<iframe src=\"https://player.vimeo.com/video/122031315\" width=\"400\" height=\"224\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>" } [/block] Developed with industry professionals, the UCPC system allows for identification and tracking of products with consumer identification at the forefront. We created the UCPC system with a few goals and problems in mind: 1. People deserve better ways to get accurate information about what they are consuming. 2. The hundreds of thousands of people in the cottage cannabis industry deserve to be represented at all levels of tracking. 3. Over the years, cannabis strain names have be re-used by various seed companies so the name alone is not enough. 4. The product code should not just be random digits, but allow for learned identification purposes for consumers, producers and retailers, or for protection in cases of recalls for health concerns. 5. The product code should have business usage in mind and not include characters or digits that are hard to read when hand-written, or hard to understand when spoken. When using the Cannabis Reports API, you'll be able to identify individual [strains](doc:strains), [extracts](doc:extracts), [edibles](doc:edibles), [products](doc:products), [producers](doc:producers), and [seed companies](doc:seed-company-object) using their unique UCPC codes.
Cannabis Reports developed the UCPC system to allow for intricate tracking and linking of products throughout the cannabis industry. It's like a [UPC](http://en.wikipedia.org/wiki/Universal_Product_Code) for cannabis. Since a UCPC is unique and forever tied to a product, it's safe to use for labelling and lets consumers get access to detailed information about their products. Here's a video of it in action: [block:html] { "html": "<iframe src=\"https://player.vimeo.com/video/122031315\" width=\"400\" height=\"224\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>" } [/block] Developed with industry professionals, the UCPC system allows for identification and tracking of products with consumer identification at the forefront. We created the UCPC system with a few goals and problems in mind: 1. People deserve better ways to get accurate information about what they are consuming. 2. The hundreds of thousands of people in the cottage cannabis industry deserve to be represented at all levels of tracking. 3. Over the years, cannabis strain names have be re-used by various seed companies so the name alone is not enough. 4. The product code should not just be random digits, but allow for learned identification purposes for consumers, producers and retailers, or for protection in cases of recalls for health concerns. 5. The product code should have business usage in mind and not include characters or digits that are hard to read when hand-written, or hard to understand when spoken. When using the Cannabis Reports API, you'll be able to identify individual [strains](doc:strains), [extracts](doc:extracts), [edibles](doc:edibles), [products](doc:products), [producers](doc:producers), and [seed companies](doc:seed-company-object) using their unique UCPC codes.
{"__v":3,"_id":"5543f62462b30e0d004b1820","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"body":"The UCPC is a 25 digit combination of letters and numbers consisting of five pieces of identification for the product. Each piece has been assigned a unique 5 digit code in the system. You can use the UCPC for each section to access that particular piece of information in our system.\n\n1. [Seed Company](doc:seed-company-object)\n2. [Strain](doc:strain-object)\n3. [Producer](producer-object)\n4. Product\n5. Batch","category":"5543f5c8795b590d001dc9f1","createdAt":"2015-05-01T21:54:44.425Z","excerpt":"The five pieces of a UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"ucpc-breakdown","sync_unique":"","title":"UCPC Breakdown","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

UCPC Breakdown

The five pieces of a UCPC.

The UCPC is a 25 digit combination of letters and numbers consisting of five pieces of identification for the product. Each piece has been assigned a unique 5 digit code in the system. You can use the UCPC for each section to access that particular piece of information in our system. 1. [Seed Company](doc:seed-company-object) 2. [Strain](doc:strain-object) 3. [Producer](producer-object) 4. Product 5. Batch
The UCPC is a 25 digit combination of letters and numbers consisting of five pieces of identification for the product. Each piece has been assigned a unique 5 digit code in the system. You can use the UCPC for each section to access that particular piece of information in our system. 1. [Seed Company](doc:seed-company-object) 2. [Strain](doc:strain-object) 3. [Producer](producer-object) 4. Product 5. Batch
{"__v":7,"_id":"5543f6af12245b1900ba0983","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"To illustrate how the UCPC system works, we've chosen the code for a disposable AK-47 vaporizer from BumbleBee: \n\n    CYGU94JYKYUY9V7TAFL200000\n\nThe product can be reached from the following link:\n\nhttps://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000\n\nThis will redirect you to the correct page in Cannabis Reports:\n\nhttps://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"UCPC\",\n    \"h-1\": \"UCPC For\",\n    \"h-2\": \"Resolves To\",\n    \"0-0\": \"Seed Company\",\n    \"0-1\": \"`CYGU9`4JYKYUY9V7TAFL200000\\n\\n*CYGU9*00000000000000000000\",\n    \"0-2\": \"[Serious Seeds](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)\",\n    \"1-0\": \"Strain\",\n    \"1-1\": \"CYGU9`4JYKY`UY9V7TAFL200000\\n\\n*CYGU94JYKY*000000000000000\",\n    \"h-3\": \"Link\",\n    \"0-3\": \"[/ucpc/CYGU900000000000000000000](https://www.smokereports.com/ucpc/CYGU900000000000000000000)\",\n    \"1-2\": \"[AK-47](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)\",\n    \"1-3\": \"[/ucpc/CYGU94JYKY000000000000000](https://www.smokereports.com/ucpc/CYGU94JYKY000000000000000)\",\n    \"2-0\": \"Producer\",\n    \"2-1\": \"CYGU94JYKY`UY9V7`TAFL200000\\n\\n0000000000*UY9V7*00000000000\",\n    \"2-2\": \"[BumbleBee](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)\",\n    \"2-3\": \"[/ucpc/0000000000UY9V70000000000](https://www.smokereports.com/ucpc/0000000000UY9V70000000000)\",\n    \"3-0\": \"Product\",\n    \"3-1\": \"CYGU94JYKYUY9V7`TAFL2`00000\\n\\n*CYGU94JYKYUY9V7TAFL2*00000\",\n    \"3-2\": \"[Serious Seeds AK-47 Disposable Vaporizer from BumbleBee](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)\",\n    \"3-3\": \"[/ucpc/CYGU94JYKYUY9V7TAFL200000](https://www.smokereports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)\",\n    \"4-0\": \"Batch\",\n    \"4-1\": \"CYGU94JYKYUY9V7TAFL2`00000`\\n\\nCYGU94JYKYUY9V7TAFL2*00000*\",\n    \"4-2\": \"N/A - This is the parent listing for the product.\",\n    \"4-3\": \"This is the parent listing for the product.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\nEach part can be reached on Cannabis Reports by its corresponding UCPC.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"UCPC Part\",\n    \"h-1\": \"Link\",\n    \"0-0\": \"[Serious Seeds](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)\",\n    \"1-0\": \"[AK-47](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)\",\n    \"2-0\": \"[BumbleBee](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)\",\n    \"3-0\": \"[Serious Seeds AK-47 Disposable Vaporizer from BumbleBee](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)\",\n    \"4-0\": \"\",\n    \"0-1\": \"[/ucpc/CYGU900000000000000000000](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)\",\n    \"1-1\": \"[/ucpc/CYGU94JYKY000000000000000](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)\",\n    \"2-1\": \"[/ucpc/0000000000UY9V70000000000](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)\",\n    \"3-1\": \"[/ucpc/CYGU94JYKYUY9V7TAFL200000](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"AK-47 - Vaporizer Disposable\\\",\\n    \\\"ucpc\\\": \\\"CYGU94JYKYUY9V7TAFL200000\\\",\\n    \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000\\\",\\n    \\\"qr\\\": \\\"https://www.cannabisreports.com/extract-reports/qr-code/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\\\",\\n    \\\"barcode\\\": \\\"https://www.cannabisreports.com/extract-reports/barcode/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\\\",\\n    \\\"url\\\": \\\"https://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable\\\",\\n    \\\"image\\\": \\\"https://www.cannabisreports.com/images/extracts/e/full_ef59374e7687e59184f4860e1720a1f908f03bf1.jpg\\\",\\n    \\\"producer\\\": {\\n        \\\"name\\\": \\\"BumbleBee\\\",\\n        \\\"ucpc\\\": \\\"0000000000UY9V70000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000UY9V70000000000\\\"\\n    },\\n    \\\"type\\\": \\\"vaporizer disposable\\\",\\n    \\\"strain\\\": {\\n        \\\"name\\\": \\\"AK-47\\\",\\n        \\\"ucpc\\\": \\\"CYGU94JYKY000000000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/CYGU94JYKY000000000000000\\\"\\n    },\\n    \\\"labTest\\\": false,\\n    \\\"thc\\\": false,\\n    \\\"cbd\\\": false,\\n    \\\"reviews\\\": {\\n        \\\"count\\\": 0,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000/reviews\\\"\\n    },\\n    \\\"createdAt\\\": {\\n        \\\"datetime\\\": \\\"2014-12-02 22:58:19\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    },\\n    \\\"updatedAt\\\": {\\n        \\\"datetime\\\": \\\"2014-12-02 22:58:19\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Begin Navigating the Different Objects\"\n}\n[/block]\nThe Cannabis Reports API has organized information on many different facets of the cannabis industry. We have categorized the available information so that you can easily locate and use the data that is relevant to your cannabis project:\n\n* [Strain Object](doc:strain-object)\n* [Extract Object](doc:extract-object)\n* [Edible Object](doc:edible-object)\n* [Product Object](doc:product-object)\n* [Producer Object](doc:producer-object)\n* [Dispensary Object](doc:dispensary-object)\n* [Seed Company Object](doc:seed-company-object)\n\nEach of these object sections details the types of information available for all of the cannabis categories. You can explore the available endpoints in the column to the left of the page.\n\nOnce you determine the cannabis information that you would like to pull from the database, you can begin making requests immediately within the documentation. If you would like to [request API credentials](doc:the-cannabis-reports-api#request-api-credentials), please reach out to us through your [free Cannabis Reports account](https://www.cannabisreports.com/my/api).","category":"5543f5c8795b590d001dc9f1","createdAt":"2015-05-01T21:57:03.546Z","excerpt":"Explanation of how the UCPC system works for individual products.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"ucpc-example","sync_unique":"","title":"UCPC Example","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

UCPC Example

Explanation of how the UCPC system works for individual products.

To illustrate how the UCPC system works, we've chosen the code for a disposable AK-47 vaporizer from BumbleBee: CYGU94JYKYUY9V7TAFL200000 The product can be reached from the following link: https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000 This will redirect you to the correct page in Cannabis Reports: https://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable [block:parameters] { "data": { "h-0": "UCPC", "h-1": "UCPC For", "h-2": "Resolves To", "0-0": "Seed Company", "0-1": "`CYGU9`4JYKYUY9V7TAFL200000\n\n*CYGU9*00000000000000000000", "0-2": "[Serious Seeds](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)", "1-0": "Strain", "1-1": "CYGU9`4JYKY`UY9V7TAFL200000\n\n*CYGU94JYKY*000000000000000", "h-3": "Link", "0-3": "[/ucpc/CYGU900000000000000000000](https://www.smokereports.com/ucpc/CYGU900000000000000000000)", "1-2": "[AK-47](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)", "1-3": "[/ucpc/CYGU94JYKY000000000000000](https://www.smokereports.com/ucpc/CYGU94JYKY000000000000000)", "2-0": "Producer", "2-1": "CYGU94JYKY`UY9V7`TAFL200000\n\n0000000000*UY9V7*00000000000", "2-2": "[BumbleBee](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)", "2-3": "[/ucpc/0000000000UY9V70000000000](https://www.smokereports.com/ucpc/0000000000UY9V70000000000)", "3-0": "Product", "3-1": "CYGU94JYKYUY9V7`TAFL2`00000\n\n*CYGU94JYKYUY9V7TAFL2*00000", "3-2": "[Serious Seeds AK-47 Disposable Vaporizer from BumbleBee](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)", "3-3": "[/ucpc/CYGU94JYKYUY9V7TAFL200000](https://www.smokereports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)", "4-0": "Batch", "4-1": "CYGU94JYKYUY9V7TAFL2`00000`\n\nCYGU94JYKYUY9V7TAFL2*00000*", "4-2": "N/A - This is the parent listing for the product.", "4-3": "This is the parent listing for the product." }, "cols": 3, "rows": 5 } [/block] Each part can be reached on Cannabis Reports by its corresponding UCPC. [block:parameters] { "data": { "h-0": "UCPC Part", "h-1": "Link", "0-0": "[Serious Seeds](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)", "1-0": "[AK-47](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)", "2-0": "[BumbleBee](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)", "3-0": "[Serious Seeds AK-47 Disposable Vaporizer from BumbleBee](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)", "4-0": "", "0-1": "[/ucpc/CYGU900000000000000000000](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)", "1-1": "[/ucpc/CYGU94JYKY000000000000000](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)", "2-1": "[/ucpc/0000000000UY9V70000000000](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)", "3-1": "[/ucpc/CYGU94JYKYUY9V7TAFL200000](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)" }, "cols": 2, "rows": 4 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"AK-47 - Vaporizer Disposable\",\n \"ucpc\": \"CYGU94JYKYUY9V7TAFL200000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000\",\n \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\",\n \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\",\n \"url\": \"https://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable\",\n \"image\": \"https://www.cannabisreports.com/images/extracts/e/full_ef59374e7687e59184f4860e1720a1f908f03bf1.jpg\",\n \"producer\": {\n \"name\": \"BumbleBee\",\n \"ucpc\": \"0000000000UY9V70000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000UY9V70000000000\"\n },\n \"type\": \"vaporizer disposable\",\n \"strain\": {\n \"name\": \"AK-47\",\n \"ucpc\": \"CYGU94JYKY000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/CYGU94JYKY000000000000000\"\n },\n \"labTest\": false,\n \"thc\": false,\n \"cbd\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2014-12-02 22:58:19\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2014-12-02 22:58:19\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Begin Navigating the Different Objects" } [/block] The Cannabis Reports API has organized information on many different facets of the cannabis industry. We have categorized the available information so that you can easily locate and use the data that is relevant to your cannabis project: * [Strain Object](doc:strain-object) * [Extract Object](doc:extract-object) * [Edible Object](doc:edible-object) * [Product Object](doc:product-object) * [Producer Object](doc:producer-object) * [Dispensary Object](doc:dispensary-object) * [Seed Company Object](doc:seed-company-object) Each of these object sections details the types of information available for all of the cannabis categories. You can explore the available endpoints in the column to the left of the page. Once you determine the cannabis information that you would like to pull from the database, you can begin making requests immediately within the documentation. If you would like to [request API credentials](doc:the-cannabis-reports-api#request-api-credentials), please reach out to us through your [free Cannabis Reports account](https://www.cannabisreports.com/my/api).
To illustrate how the UCPC system works, we've chosen the code for a disposable AK-47 vaporizer from BumbleBee: CYGU94JYKYUY9V7TAFL200000 The product can be reached from the following link: https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000 This will redirect you to the correct page in Cannabis Reports: https://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable [block:parameters] { "data": { "h-0": "UCPC", "h-1": "UCPC For", "h-2": "Resolves To", "0-0": "Seed Company", "0-1": "`CYGU9`4JYKYUY9V7TAFL200000\n\n*CYGU9*00000000000000000000", "0-2": "[Serious Seeds](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)", "1-0": "Strain", "1-1": "CYGU9`4JYKY`UY9V7TAFL200000\n\n*CYGU94JYKY*000000000000000", "h-3": "Link", "0-3": "[/ucpc/CYGU900000000000000000000](https://www.smokereports.com/ucpc/CYGU900000000000000000000)", "1-2": "[AK-47](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)", "1-3": "[/ucpc/CYGU94JYKY000000000000000](https://www.smokereports.com/ucpc/CYGU94JYKY000000000000000)", "2-0": "Producer", "2-1": "CYGU94JYKY`UY9V7`TAFL200000\n\n0000000000*UY9V7*00000000000", "2-2": "[BumbleBee](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)", "2-3": "[/ucpc/0000000000UY9V70000000000](https://www.smokereports.com/ucpc/0000000000UY9V70000000000)", "3-0": "Product", "3-1": "CYGU94JYKYUY9V7`TAFL2`00000\n\n*CYGU94JYKYUY9V7TAFL2*00000", "3-2": "[Serious Seeds AK-47 Disposable Vaporizer from BumbleBee](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)", "3-3": "[/ucpc/CYGU94JYKYUY9V7TAFL200000](https://www.smokereports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)", "4-0": "Batch", "4-1": "CYGU94JYKYUY9V7TAFL2`00000`\n\nCYGU94JYKYUY9V7TAFL2*00000*", "4-2": "N/A - This is the parent listing for the product.", "4-3": "This is the parent listing for the product." }, "cols": 3, "rows": 5 } [/block] Each part can be reached on Cannabis Reports by its corresponding UCPC. [block:parameters] { "data": { "h-0": "UCPC Part", "h-1": "Link", "0-0": "[Serious Seeds](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)", "1-0": "[AK-47](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)", "2-0": "[BumbleBee](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)", "3-0": "[Serious Seeds AK-47 Disposable Vaporizer from BumbleBee](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)", "4-0": "", "0-1": "[/ucpc/CYGU900000000000000000000](https://www.cannabisreports.com/ucpc/CYGU900000000000000000000)", "1-1": "[/ucpc/CYGU94JYKY000000000000000](https://www.cannabisreports.com/ucpc/CYGU94JYKY000000000000000)", "2-1": "[/ucpc/0000000000UY9V70000000000](https://www.cannabisreports.com/ucpc/0000000000UY9V70000000000)", "3-1": "[/ucpc/CYGU94JYKYUY9V7TAFL200000](https://www.cannabisreports.com/ucpc/CYGU94JYKYUY9V7TAFL200000)" }, "cols": 2, "rows": 4 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"AK-47 - Vaporizer Disposable\",\n \"ucpc\": \"CYGU94JYKYUY9V7TAFL200000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000\",\n \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\",\n \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\",\n \"url\": \"https://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable\",\n \"image\": \"https://www.cannabisreports.com/images/extracts/e/full_ef59374e7687e59184f4860e1720a1f908f03bf1.jpg\",\n \"producer\": {\n \"name\": \"BumbleBee\",\n \"ucpc\": \"0000000000UY9V70000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000UY9V70000000000\"\n },\n \"type\": \"vaporizer disposable\",\n \"strain\": {\n \"name\": \"AK-47\",\n \"ucpc\": \"CYGU94JYKY000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/CYGU94JYKY000000000000000\"\n },\n \"labTest\": false,\n \"thc\": false,\n \"cbd\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2014-12-02 22:58:19\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2014-12-02 22:58:19\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Begin Navigating the Different Objects" } [/block] The Cannabis Reports API has organized information on many different facets of the cannabis industry. We have categorized the available information so that you can easily locate and use the data that is relevant to your cannabis project: * [Strain Object](doc:strain-object) * [Extract Object](doc:extract-object) * [Edible Object](doc:edible-object) * [Product Object](doc:product-object) * [Producer Object](doc:producer-object) * [Dispensary Object](doc:dispensary-object) * [Seed Company Object](doc:seed-company-object) Each of these object sections details the types of information available for all of the cannabis categories. You can explore the available endpoints in the column to the left of the page. Once you determine the cannabis information that you would like to pull from the database, you can begin making requests immediately within the documentation. If you would like to [request API credentials](doc:the-cannabis-reports-api#request-api-credentials), please reach out to us through your [free Cannabis Reports account](https://www.cannabisreports.com/my/api).
{"__v":28,"_id":"552ea8be06a32a0d009c2fbc","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis strains are the various cultivars available for the cannabis family. Thousands of years of human domestication and breeding of cannabis strains have resulted in a huge variety of attributes that we know and love today.\n\nhttp://en.wikipedia.org/wiki/Cultivar\n\nOver time, strain names have been used by various companies in their attempts to recreate the results of other breeders. Cannabis Reports identifies strains not only by their name, but by their seed company as well, to ensure they are all properly represented.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Strain Attributes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Name of the cannabis strain.\",\n    \"1-0\": \"ucpc\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) code for this strain.\",\n    \"2-0\": \"link\",\n    \"2-1\": \"`url`\",\n    \"2-2\": \"Link to the strain in the Cannabis Reports API.\",\n    \"3-0\": \"qr\",\n    \"3-1\": \"`url`\",\n    \"3-2\": \"Link to the QR code for this strain.\",\n    \"4-0\": \"url\",\n    \"4-1\": \"`url`\",\n    \"4-2\": \"Link to the strain listing on the Cannabis Reports website.\",\n    \"6-0\": \"seedCompany\",\n    \"6-1\": \"`object`\",\n    \"6-2\": \"Information about the [seed company](doc:seed-company-object) that created or provides the strain.\",\n    \"7-0\": \"seedCompany.name\",\n    \"7-1\": \"`string`\",\n    \"7-2\": \"Name of the [seed company](doc:seed-company-object) for the strain.\",\n    \"8-0\": \"seedCompany.ucpc\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) for the [seed company](doc:seed-company-object).\",\n    \"15-0\": \"children\",\n    \"15-1\": \"`object`\",\n    \"15-2\": \"Object that holds information about the children for the strain.\",\n    \"19-0\": \"reviews.count\",\n    \"19-1\": \"`integer`\",\n    \"19-2\": \"Number of reviews for the strain.\",\n    \"21-0\": \"createdAt\",\n    \"21-1\": \"`object`\",\n    \"21-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the strain was added.\",\n    \"22-0\": \"updatedAt\",\n    \"22-1\": \"`object`\",\n    \"22-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the strain was updated.\",\n    \"5-0\": \"image\",\n    \"5-1\": \"`url`\",\n    \"5-2\": \"Link to the full size image for this strain on Cannabis Reports.\",\n    \"10-0\": \"genetics\",\n    \"10-1\": \"`object`\",\n    \"10-2\": \"Object that holds information about the genetics for the strain.\",\n    \"11-0\": \"genetics.names\",\n    \"11-1\": \"`string`\",\n    \"11-2\": \"The textual representation of the genetics for a strain.\",\n    \"12-0\": \"genetics.ucpc\",\n    \"12-1\": \"`string`\",\n    \"12-2\": \"The genetics of a strain with UCPC codes instead of names. Delimiters in the genetic string are parentheses (), lower case \\\"x\\\", common slash /, and question mark ?. These characters will never be included within the UCPC.\",\n    \"14-0\": \"lineage\",\n    \"14-1\": \"`object`\",\n    \"14-2\": \"Countries of origin for the genetics for the strain. Object keys are the country name and the values are the two character country codes.\",\n    \"13-0\": \"genetics.link\",\n    \"13-1\": \"`url`\",\n    \"13-2\": \"Link to the genetics for the strain in the Cannabis Reports API.\",\n    \"17-0\": \"children.link\",\n    \"20-0\": \"reviews.link\",\n    \"17-1\": \"`url`\",\n    \"20-1\": \"`url`\",\n    \"17-2\": \"Link to the children for the strain in the Cannabis Reports API.\",\n    \"20-2\": \"Link to the reviews for the strain in the Cannabis Reports API.\",\n    \"9-0\": \"seedCompany.link\",\n    \"9-1\": \"`url`\",\n    \"9-2\": \"Link to the [seed company](doc:seed-company-object) for the strain in the Cannabis Reports API.\",\n    \"16-0\": \"children.count\",\n    \"16-1\": \"`integer`\",\n    \"16-2\": \"Number of strains this one has been bred into.\",\n    \"18-0\": \"reviews\",\n    \"18-1\": \"`object`\",\n    \"18-2\": \"Object that holds information about the reviews for the strain.\"\n  },\n  \"cols\": 3,\n  \"rows\": 23\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"Jack Herer\\\",\\n    \\\"ucpc\\\": \\\"VUJCJ4TYMG000000000000000\\\",\\n    \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\\\",\\n    \\\"qr\\\": \\\"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-herer/qr-code.svg\\\",\\n    \\\"url\\\": \\\"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-herer\\\",\\n    \\\"image\\\": \\\"https://www.cannabisreports.com/images/strains/a/full_ae82eef3bb2b7694df7f8bfa0da22a5d2b0f3689.jpg\\\",\\n    \\\"seedCompany\\\": {\\n        \\\"name\\\": \\\"Sensi Seeds\\\",\\n        \\\"ucpc\\\": \\\"VUJCJ00000000000000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/seed-companies/VUJCJ00000000000000000000\\\"\\n    },\\n    \\\"genetics\\\": {\\n        \\\"names\\\": \\\"(Northern Lights #5 x Skunk #1) x Haze\\\",\\n        \\\"ucpc\\\": \\\"(VUJCJ4MPQ2000000000000000 x VUJCJY6ZUC000000000000000) x 9XVU7WJQCD000000000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/genetics\\\"\\n    },\\n    \\\"lineage\\\": {\\n        \\\"Afghanistan\\\": \\\"AF\\\",\\n        \\\"Colombia\\\": \\\"CO\\\",\\n        \\\"India\\\": \\\"IN\\\",\\n        \\\"Mexico\\\": \\\"MX\\\",\\n        \\\"Thailand\\\": \\\"TH\\\"\\n    },\\n    \\\"children\\\": {\\n        \\\"count\\\": 96,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/children\\\"\\n    },\\n    \\\"reviews\\\": {\\n        \\\"count\\\": 3,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/reviews\\\"\\n    },\\n    \\\"createdAt\\\": {\\n        \\\"datetime\\\": \\\"2008-08-15 19:20:00\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    },\\n    \\\"updatedAt\\\": {\\n        \\\"datetime\\\": \\\"2015-03-11 23:10:50\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Where's Indica, Sativa, Hybrid?\"\n}\n[/block]\nMainstream cannabis science does not subscribe to what has become a common classification scheme for identifying cannabis strains. There are differing opinions on the appropriate taxonomy of cannabis in the scientific community. Until there is consensus, Cannabis Reports does not participate in this type of classification.\n\nCannabis consumers have become used to associating feelings to these words which were previously used to describe physical or genetic characteristics of a plant.\n\nTo this effect, we have given [producers](doc:producer-object) the ability to classify their products as indica, sativa, and hybrid as it has become part of the common vocabulary. We have also allowed for strains to be listed on menus in ways that consumers have grown accustomed to, with most strains ending up in the \"hybrid\" category.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Where are the THC, CBD, and Other Percentages for Strains?\"\n}\n[/block]\nResults from cannabis labs on the percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) and [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) content are based upon samples of the overall harvest for particular strains.\n\nThe cannabis plant contains hundreds of chemicals that interact together to provide the experience you have when you consume it. Science has shown that genetics of a strain can determine whether the disposition exists to produce the chemicals we measure for. However, the overall abundance of them in what you are consuming can vary depending on many factors:\n\n1. Skill of producer.\n2. Environment.\n3. Genetic phenotypes from seeds.\n4. Part of plant consumed.\n5. Processing.\n\nCannabis Reports lets [producers](doc:producer-object) tie lab tests to individual products, batches of products, or flowers. For the overall information of a cannabis strain, however, we recognize that the actual results can vary from crop to crop.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Explore Strain Endpoints\"\n}\n[/block]\nHere are some of the results available from the different strain endpoints:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint\",\n    \"h-1\": \"Result\",\n    \"0-0\": \"[/strains](doc:strains)\",\n    \"0-1\": \"Gets a paginated list of strains with optional sorting.\",\n    \"1-0\": \"[/strains/search/:query](doc: strains-search-query)\",\n    \"1-1\": \"Returns search results for strains in our database.\",\n    \"2-0\": \"[/strains/:ucpc](doc:strains-ucpc)\",\n    \"2-1\": \"Gets an individual strain based on the UCPC.\",\n    \"3-0\": \"[/strains/:ucpc/reviews](doc:strains-ucpc-reviews)\",\n    \"3-1\": \"Gets the reviews for a cannabis strain.\",\n    \"4-0\": \"[/strains/:ucpc/effectsFlavors](doc:strains-ucpc-effectsflavors)\",\n    \"4-1\": \"Gets the average effects and flavors from reviews for this strain.\",\n    \"5-0\": \"[/strains/:ucpc/seedCompany](doc:strains-ucpc-seedcompany)\",\n    \"5-1\": \"Gets the seed company that was responsible for a cannabis strain.\",\n    \"6-1\": \"Gets the strains that were the parent material for the strain with the given UCPC.\",\n    \"6-0\": \"[/strains/:ucpc/genetics](doc:strains-ucpc-genetics)\",\n    \"7-0\": \"[/strains/:ucpc/children](doc:strains-ucpc-children)\",\n    \"7-1\": \"Gets the child strains that this one has been bred into.\",\n    \"8-0\": \"[/strains/:ucpc/availability/geo/:lat/:lng/:radius](doc:strains-ucpc-availability-geo-lat-lng-radius)\",\n    \"8-1\": \"Gets information about the availability of a strain using latitude and longitude.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-15T18:06:54.785Z","excerpt":"Cannabis strains in the Cannabis Reports system.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"strain-object","sync_unique":"","title":"Strain Object","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Strain Object

Cannabis strains in the Cannabis Reports system.

Cannabis strains are the various cultivars available for the cannabis family. Thousands of years of human domestication and breeding of cannabis strains have resulted in a huge variety of attributes that we know and love today. http://en.wikipedia.org/wiki/Cultivar Over time, strain names have been used by various companies in their attempts to recreate the results of other breeders. Cannabis Reports identifies strains not only by their name, but by their seed company as well, to ensure they are all properly represented. [block:api-header] { "type": "basic", "title": "Strain Attributes" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the cannabis strain.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this strain.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the strain in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this strain.", "4-0": "url", "4-1": "`url`", "4-2": "Link to the strain listing on the Cannabis Reports website.", "6-0": "seedCompany", "6-1": "`object`", "6-2": "Information about the [seed company](doc:seed-company-object) that created or provides the strain.", "7-0": "seedCompany.name", "7-1": "`string`", "7-2": "Name of the [seed company](doc:seed-company-object) for the strain.", "8-0": "seedCompany.ucpc", "8-1": "`string`", "8-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [seed company](doc:seed-company-object).", "15-0": "children", "15-1": "`object`", "15-2": "Object that holds information about the children for the strain.", "19-0": "reviews.count", "19-1": "`integer`", "19-2": "Number of reviews for the strain.", "21-0": "createdAt", "21-1": "`object`", "21-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the strain was added.", "22-0": "updatedAt", "22-1": "`object`", "22-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the strain was updated.", "5-0": "image", "5-1": "`url`", "5-2": "Link to the full size image for this strain on Cannabis Reports.", "10-0": "genetics", "10-1": "`object`", "10-2": "Object that holds information about the genetics for the strain.", "11-0": "genetics.names", "11-1": "`string`", "11-2": "The textual representation of the genetics for a strain.", "12-0": "genetics.ucpc", "12-1": "`string`", "12-2": "The genetics of a strain with UCPC codes instead of names. Delimiters in the genetic string are parentheses (), lower case \"x\", common slash /, and question mark ?. These characters will never be included within the UCPC.", "14-0": "lineage", "14-1": "`object`", "14-2": "Countries of origin for the genetics for the strain. Object keys are the country name and the values are the two character country codes.", "13-0": "genetics.link", "13-1": "`url`", "13-2": "Link to the genetics for the strain in the Cannabis Reports API.", "17-0": "children.link", "20-0": "reviews.link", "17-1": "`url`", "20-1": "`url`", "17-2": "Link to the children for the strain in the Cannabis Reports API.", "20-2": "Link to the reviews for the strain in the Cannabis Reports API.", "9-0": "seedCompany.link", "9-1": "`url`", "9-2": "Link to the [seed company](doc:seed-company-object) for the strain in the Cannabis Reports API.", "16-0": "children.count", "16-1": "`integer`", "16-2": "Number of strains this one has been bred into.", "18-0": "reviews", "18-1": "`object`", "18-2": "Object that holds information about the reviews for the strain." }, "cols": 3, "rows": 23 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Jack Herer\",\n \"ucpc\": \"VUJCJ4TYMG000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\",\n \"qr\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-herer/qr-code.svg\",\n \"url\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-herer\",\n \"image\": \"https://www.cannabisreports.com/images/strains/a/full_ae82eef3bb2b7694df7f8bfa0da22a5d2b0f3689.jpg\",\n \"seedCompany\": {\n \"name\": \"Sensi Seeds\",\n \"ucpc\": \"VUJCJ00000000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/VUJCJ00000000000000000000\"\n },\n \"genetics\": {\n \"names\": \"(Northern Lights #5 x Skunk #1) x Haze\",\n \"ucpc\": \"(VUJCJ4MPQ2000000000000000 x VUJCJY6ZUC000000000000000) x 9XVU7WJQCD000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/genetics\"\n },\n \"lineage\": {\n \"Afghanistan\": \"AF\",\n \"Colombia\": \"CO\",\n \"India\": \"IN\",\n \"Mexico\": \"MX\",\n \"Thailand\": \"TH\"\n },\n \"children\": {\n \"count\": 96,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/children\"\n },\n \"reviews\": {\n \"count\": 3,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2008-08-15 19:20:00\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-03-11 23:10:50\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Where's Indica, Sativa, Hybrid?" } [/block] Mainstream cannabis science does not subscribe to what has become a common classification scheme for identifying cannabis strains. There are differing opinions on the appropriate taxonomy of cannabis in the scientific community. Until there is consensus, Cannabis Reports does not participate in this type of classification. Cannabis consumers have become used to associating feelings to these words which were previously used to describe physical or genetic characteristics of a plant. To this effect, we have given [producers](doc:producer-object) the ability to classify their products as indica, sativa, and hybrid as it has become part of the common vocabulary. We have also allowed for strains to be listed on menus in ways that consumers have grown accustomed to, with most strains ending up in the "hybrid" category. [block:api-header] { "type": "basic", "title": "Where are the THC, CBD, and Other Percentages for Strains?" } [/block] Results from cannabis labs on the percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) and [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) content are based upon samples of the overall harvest for particular strains. The cannabis plant contains hundreds of chemicals that interact together to provide the experience you have when you consume it. Science has shown that genetics of a strain can determine whether the disposition exists to produce the chemicals we measure for. However, the overall abundance of them in what you are consuming can vary depending on many factors: 1. Skill of producer. 2. Environment. 3. Genetic phenotypes from seeds. 4. Part of plant consumed. 5. Processing. Cannabis Reports lets [producers](doc:producer-object) tie lab tests to individual products, batches of products, or flowers. For the overall information of a cannabis strain, however, we recognize that the actual results can vary from crop to crop. [block:api-header] { "type": "basic", "title": "Explore Strain Endpoints" } [/block] Here are some of the results available from the different strain endpoints: [block:parameters] { "data": { "h-0": "Endpoint", "h-1": "Result", "0-0": "[/strains](doc:strains)", "0-1": "Gets a paginated list of strains with optional sorting.", "1-0": "[/strains/search/:query](doc: strains-search-query)", "1-1": "Returns search results for strains in our database.", "2-0": "[/strains/:ucpc](doc:strains-ucpc)", "2-1": "Gets an individual strain based on the UCPC.", "3-0": "[/strains/:ucpc/reviews](doc:strains-ucpc-reviews)", "3-1": "Gets the reviews for a cannabis strain.", "4-0": "[/strains/:ucpc/effectsFlavors](doc:strains-ucpc-effectsflavors)", "4-1": "Gets the average effects and flavors from reviews for this strain.", "5-0": "[/strains/:ucpc/seedCompany](doc:strains-ucpc-seedcompany)", "5-1": "Gets the seed company that was responsible for a cannabis strain.", "6-1": "Gets the strains that were the parent material for the strain with the given UCPC.", "6-0": "[/strains/:ucpc/genetics](doc:strains-ucpc-genetics)", "7-0": "[/strains/:ucpc/children](doc:strains-ucpc-children)", "7-1": "Gets the child strains that this one has been bred into.", "8-0": "[/strains/:ucpc/availability/geo/:lat/:lng/:radius](doc:strains-ucpc-availability-geo-lat-lng-radius)", "8-1": "Gets information about the availability of a strain using latitude and longitude." }, "cols": 2, "rows": 9 } [/block]
Cannabis strains are the various cultivars available for the cannabis family. Thousands of years of human domestication and breeding of cannabis strains have resulted in a huge variety of attributes that we know and love today. http://en.wikipedia.org/wiki/Cultivar Over time, strain names have been used by various companies in their attempts to recreate the results of other breeders. Cannabis Reports identifies strains not only by their name, but by their seed company as well, to ensure they are all properly represented. [block:api-header] { "type": "basic", "title": "Strain Attributes" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the cannabis strain.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this strain.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the strain in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this strain.", "4-0": "url", "4-1": "`url`", "4-2": "Link to the strain listing on the Cannabis Reports website.", "6-0": "seedCompany", "6-1": "`object`", "6-2": "Information about the [seed company](doc:seed-company-object) that created or provides the strain.", "7-0": "seedCompany.name", "7-1": "`string`", "7-2": "Name of the [seed company](doc:seed-company-object) for the strain.", "8-0": "seedCompany.ucpc", "8-1": "`string`", "8-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [seed company](doc:seed-company-object).", "15-0": "children", "15-1": "`object`", "15-2": "Object that holds information about the children for the strain.", "19-0": "reviews.count", "19-1": "`integer`", "19-2": "Number of reviews for the strain.", "21-0": "createdAt", "21-1": "`object`", "21-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the strain was added.", "22-0": "updatedAt", "22-1": "`object`", "22-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the strain was updated.", "5-0": "image", "5-1": "`url`", "5-2": "Link to the full size image for this strain on Cannabis Reports.", "10-0": "genetics", "10-1": "`object`", "10-2": "Object that holds information about the genetics for the strain.", "11-0": "genetics.names", "11-1": "`string`", "11-2": "The textual representation of the genetics for a strain.", "12-0": "genetics.ucpc", "12-1": "`string`", "12-2": "The genetics of a strain with UCPC codes instead of names. Delimiters in the genetic string are parentheses (), lower case \"x\", common slash /, and question mark ?. These characters will never be included within the UCPC.", "14-0": "lineage", "14-1": "`object`", "14-2": "Countries of origin for the genetics for the strain. Object keys are the country name and the values are the two character country codes.", "13-0": "genetics.link", "13-1": "`url`", "13-2": "Link to the genetics for the strain in the Cannabis Reports API.", "17-0": "children.link", "20-0": "reviews.link", "17-1": "`url`", "20-1": "`url`", "17-2": "Link to the children for the strain in the Cannabis Reports API.", "20-2": "Link to the reviews for the strain in the Cannabis Reports API.", "9-0": "seedCompany.link", "9-1": "`url`", "9-2": "Link to the [seed company](doc:seed-company-object) for the strain in the Cannabis Reports API.", "16-0": "children.count", "16-1": "`integer`", "16-2": "Number of strains this one has been bred into.", "18-0": "reviews", "18-1": "`object`", "18-2": "Object that holds information about the reviews for the strain." }, "cols": 3, "rows": 23 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Jack Herer\",\n \"ucpc\": \"VUJCJ4TYMG000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\",\n \"qr\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-herer/qr-code.svg\",\n \"url\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-herer\",\n \"image\": \"https://www.cannabisreports.com/images/strains/a/full_ae82eef3bb2b7694df7f8bfa0da22a5d2b0f3689.jpg\",\n \"seedCompany\": {\n \"name\": \"Sensi Seeds\",\n \"ucpc\": \"VUJCJ00000000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/VUJCJ00000000000000000000\"\n },\n \"genetics\": {\n \"names\": \"(Northern Lights #5 x Skunk #1) x Haze\",\n \"ucpc\": \"(VUJCJ4MPQ2000000000000000 x VUJCJY6ZUC000000000000000) x 9XVU7WJQCD000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/genetics\"\n },\n \"lineage\": {\n \"Afghanistan\": \"AF\",\n \"Colombia\": \"CO\",\n \"India\": \"IN\",\n \"Mexico\": \"MX\",\n \"Thailand\": \"TH\"\n },\n \"children\": {\n \"count\": 96,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/children\"\n },\n \"reviews\": {\n \"count\": 3,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2008-08-15 19:20:00\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-03-11 23:10:50\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Where's Indica, Sativa, Hybrid?" } [/block] Mainstream cannabis science does not subscribe to what has become a common classification scheme for identifying cannabis strains. There are differing opinions on the appropriate taxonomy of cannabis in the scientific community. Until there is consensus, Cannabis Reports does not participate in this type of classification. Cannabis consumers have become used to associating feelings to these words which were previously used to describe physical or genetic characteristics of a plant. To this effect, we have given [producers](doc:producer-object) the ability to classify their products as indica, sativa, and hybrid as it has become part of the common vocabulary. We have also allowed for strains to be listed on menus in ways that consumers have grown accustomed to, with most strains ending up in the "hybrid" category. [block:api-header] { "type": "basic", "title": "Where are the THC, CBD, and Other Percentages for Strains?" } [/block] Results from cannabis labs on the percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) and [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) content are based upon samples of the overall harvest for particular strains. The cannabis plant contains hundreds of chemicals that interact together to provide the experience you have when you consume it. Science has shown that genetics of a strain can determine whether the disposition exists to produce the chemicals we measure for. However, the overall abundance of them in what you are consuming can vary depending on many factors: 1. Skill of producer. 2. Environment. 3. Genetic phenotypes from seeds. 4. Part of plant consumed. 5. Processing. Cannabis Reports lets [producers](doc:producer-object) tie lab tests to individual products, batches of products, or flowers. For the overall information of a cannabis strain, however, we recognize that the actual results can vary from crop to crop. [block:api-header] { "type": "basic", "title": "Explore Strain Endpoints" } [/block] Here are some of the results available from the different strain endpoints: [block:parameters] { "data": { "h-0": "Endpoint", "h-1": "Result", "0-0": "[/strains](doc:strains)", "0-1": "Gets a paginated list of strains with optional sorting.", "1-0": "[/strains/search/:query](doc: strains-search-query)", "1-1": "Returns search results for strains in our database.", "2-0": "[/strains/:ucpc](doc:strains-ucpc)", "2-1": "Gets an individual strain based on the UCPC.", "3-0": "[/strains/:ucpc/reviews](doc:strains-ucpc-reviews)", "3-1": "Gets the reviews for a cannabis strain.", "4-0": "[/strains/:ucpc/effectsFlavors](doc:strains-ucpc-effectsflavors)", "4-1": "Gets the average effects and flavors from reviews for this strain.", "5-0": "[/strains/:ucpc/seedCompany](doc:strains-ucpc-seedcompany)", "5-1": "Gets the seed company that was responsible for a cannabis strain.", "6-1": "Gets the strains that were the parent material for the strain with the given UCPC.", "6-0": "[/strains/:ucpc/genetics](doc:strains-ucpc-genetics)", "7-0": "[/strains/:ucpc/children](doc:strains-ucpc-children)", "7-1": "Gets the child strains that this one has been bred into.", "8-0": "[/strains/:ucpc/availability/geo/:lat/:lng/:radius](doc:strains-ucpc-availability-geo-lat-lng-radius)", "8-1": "Gets information about the availability of a strain using latitude and longitude." }, "cols": 2, "rows": 9 } [/block]
{"__v":7,"_id":"55280da5456b9c170001a3ec","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains?sort=name&page=3"}]},"params":[{"_id":"552c3ee10b701a1700470d86","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"552c3fc1d9f89e0d0015a5b3","default":"","desc":"How you would like the results sorted.","name":"sort","required":false,"type":"string","in":"query"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"501st OG\",\n            \"ucpc\": \"4FMDMKJYQL000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4FMDMKJYQL000000000000000\",\n            \"qr\": \"https://www.cannabisreports.com/strain-reports/rare-dankness-seeds/501st-og/qr-code.svg\",\n            \"url\": \"https://www.cannabisreports.com/strain-reports/rare-dankness-seeds/501st-og\",\n            \"image\": \"https://www.cannabisreports.com/images/strains/a/full_aac791c4ba5e08993b92130a8d95cff56cd3e242.jpg\",\n            \"seedCompany\": {\n                \"name\": \"Rare Dankness Seeds\",\n                \"ucpc\": \"4FMDM00000000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/4FMDM00000000000000000000\"\n            },\n            \"genetics\": {\n                \"names\": \"Skywalker OG x Rare Dankness #1\",\n                \"ucpc\": \"9XVU7ZDGYL000000000000000 x 4FMDM9DTWX000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4FMDMKJYQL000000000000000/genetics\"\n            },\n            \"lineage\": {\n                \"Afghanistan\": \"AF\"\n            },\n            \"children\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4FMDMKJYQL000000000000000/children\"\n            },\n            \"reviews\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4FMDMKJYQL000000000000000/reviews\"\n            },\n            \"createdAt\": {\n                \"datetime\": \"2014-10-01 17:12:35\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-10-01 17:12:35\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 4738,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 474,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/strains?sort=name&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/strains?sort=name&page=4\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","language":"json","status":400}]},"settings":"","url":"/strains"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `strains` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for more information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated, created, or alphabetically.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\",\n    \"4-0\": \"name\",\n    \"4-1\": \"Alphabetically stating with numeric strains. 0-9, A-Z.\",\n    \"5-0\": \"-name\",\n    \"5-1\": \"Alphabetically starting with Z and working back through numeric strains. Z-A, 9-0.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-10T17:51:33.519Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of strains with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"strains","sync_unique":"","title":"/strains","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains

Gets a paginated list of strains with optional sorting.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `strains` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated, created, or alphabetically. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records.", "4-0": "name", "4-1": "Alphabetically stating with numeric strains. 0-9, A-Z.", "5-0": "-name", "5-1": "Alphabetically starting with Z and working back through numeric strains. Z-A, 9-0." }, "cols": 2, "rows": 6 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `strains` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated, created, or alphabetically. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records.", "4-0": "name", "4-1": "Alphabetically stating with numeric strains. 0-9, A-Z.", "5-0": "-name", "5-1": "Alphabetically starting with Z and working back through numeric strains. Z-A, 9-0." }, "cols": 2, "rows": 6 } [/block]
{"__v":0,"_id":"552ed76b5d4baa0d00783726","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/search/Blue","name":""}]},"params":[{"_id":"552ed76b5d4baa0d00783727","default":"Blue","desc":"Search query to find strains in our system. Must be at least 2 characters.","name":"query","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Blue\",\n            \"ucpc\": \"L2KQMTUFDH000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/L2KQMTUFDH000000000000000\",\n            \"qr\": \"https://www.cannabisreports.com/strain-reports/thc-seeds/blue/qr-code.svg\",\n            \"url\": \"https://www.cannabisreports.com/strain-reports/thc-seeds/blue\",\n            \"image\": \"https://www.cannabisreports.com/images/strains/c/full_c49ce8f893df7bd23711d6deb29a5159fca97b37.jpg\",\n            \"seedCompany\": {\n                \"name\": \"THC Seeds\",\n                \"ucpc\": \"L2KQM00000000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/L2KQM00000000000000000000\"\n            },\n            \"genetics\": {\n                \"names\": false,\n                \"ucpc\": false,\n                \"link\": false\n            },\n            \"lineage\": [],\n            \"children\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/L2KQMTUFDH000000000000000/children\"\n            },\n            \"reviews\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/L2KQMTUFDH000000000000000/reviews\"\n            },\n            \"createdAt\": {\n                \"datetime\": \"2008-08-15 19:20:00\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-06-08 03:36:59\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        { ... }\n     ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 232,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 24,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/strains/search/Blue?q=Blue&page=2\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Invalid query. Query must be at least two characters.\",\n    \"status_code\": 400\n}","language":"json","status":400}]},"settings":"","url":"/strains/search/:query"},"body":"The strain search API can be used to find strains by name. Search with at least 2 characters and get an array of strains to work with.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Always Improving\",\n  \"body\": \"We're working on our search algorithm to try and provide the best results. If you have any suggestions, please reach out to us!\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-15T21:26:03.398Z","editedParams":true,"editedParams2":true,"excerpt":"Returns search results for strains in our database.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"strains-search-query","sync_unique":"","title":"/strains/search/:query","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/search/:query

Returns search results for strains in our database.

Path Params

query:
required
stringBlue
Search query to find strains in our system. Must be at least 2 characters.
The strain search API can be used to find strains by name. Search with at least 2 characters and get an array of strains to work with. [block:callout] { "type": "info", "title": "Always Improving", "body": "We're working on our search algorithm to try and provide the best results. If you have any suggestions, please reach out to us!" } [/block] [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The strain search API can be used to find strains by name. Search with at least 2 characters and get an array of strains to work with. [block:callout] { "type": "info", "title": "Always Improving", "body": "We're working on our search algorithm to try and provide the best results. If you have any suggestions, please reach out to us!" } [/block] [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":0,"_id":"552c43457820b80d00aa4f19","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"VUJCJ4TYMG000000000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis strain you want information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Jack Herer\",\n        \"ucpc\": \"VUJCJ4TYMG000000000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\",\n        \"qr\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-herer/qr-code.svg\",\n        \"url\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-herer\",\n        \"image\": \"https://www.cannabisreports.com/images/strains/a/full_ae82eef3bb2b7694df7f8bfa0da22a5d2b0f3689.jpg\",\n        \"seedCompany\": {\n            \"name\": \"Sensi Seeds\",\n            \"ucpc\": \"VUJCJ00000000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/VUJCJ00000000000000000000\"\n        },\n        \"genetics\": {\n            \"names\": \"(Northern Lights #5 x Skunk #1) x Haze\",\n            \"ucpc\": \"(VUJCJ4MPQ2000000000000000 x VUJCJY6ZUC000000000000000) x 9XVU7WJQCD000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/genetics\"\n        },\n        \"lineage\": {\n            \"Afghanistan\": \"AF\",\n            \"Colombia\": \"CO\",\n            \"India\": \"IN\",\n            \"Mexico\": \"MX\",\n            \"Thailand\": \"TH\"\n        },\n        \"children\": {\n            \"count\": 94,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/children\"\n        },\n        \"reviews\": {\n            \"count\": 3,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/reviews\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2008-08-15 19:20:00\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-03-11 23:10:50\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a strain with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/strains/:ucpc"},"body":"","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-13T22:29:25.734Z","editedParams":true,"editedParams2":true,"excerpt":"Gets an individual strain based on the UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"strains-ucpc","sync_unique":"","title":"/strains/:ucpc","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/:ucpc

Gets an individual strain based on the UCPC.

Path Params

ucpc:
required
stringVUJCJ4TYMG000000000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis strain you want information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"552fd625633a5b0d00e99e25","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/user","name":""}]},"params":[{"_id":"552fd625633a5b0d00e99e26","default":"VUJCJ4TYMG000000000000000","desc":"[UCPC](ucpc-universal-cannabis-product-code) of the strain you want the user from.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"nickname\": \"David\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/users/david\",\n        \"tagline\": \"The Original Smoke Reporter\",\n        \"url\": \"https://www.cannabisreports.com/user/profile/david\",\n        \"slug\": \"david\",\n        \"createdAt\": {\n            \"datetime\": \"2008-08-15 16:20:00\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-05-06 22:10:18\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a strain with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/strains/:ucpc/user"},"body":"","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-16T15:32:53.482Z","editedParams":true,"editedParams2":true,"excerpt":"Get the user who added the strain to the database.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55232972e2de0a3500f0a2df","slug":"strains-ucpc-user","sync_unique":"","title":"/strains/:ucpc/user","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/:ucpc/user

Get the user who added the strain to the database.

Path Params

ucpc:
required
stringVUJCJ4TYMG000000000000000
[UCPC](ucpc-universal-cannabis-product-code) of the strain you want the user from.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"552fd5a9f99ae00d00e054d1","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/reviews","name":""}]},"params":[{"_id":"552fd5a9f99ae00d00e054d2","default":"VUJCJ4TYMG000000000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the strain you would like reviews for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/reviews/323d4a3364f9d218ae13f71364b2297462878270\",\n            \"url\": \"https://www.cannabisreports.com/smoke-reports/2010/11/06/323d4a3364f9d218ae13f71364b2297462878270/smokinmama\",\n            \"euphoria\": \"7\",\n            \"creativity\": null,\n            \"pain_relief\": null,\n            \"appetite_gain\": \"4\",\n            \"calming\": null,\n            \"anxiety\": \"3\",\n            \"spicy\": \"7\",\n            \"earthy\": \"7\",\n            \"fruity\": \"2\",\n            \"sour\": \"3\",\n            \"dry_mouth\": null,\n            \"createdAt\": {\n                \"datetime\": \"2010-11-06 15:35:47\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-05-16 01:53:28\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 3,\n            \"count\": 3,\n            \"per_page\": 20,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n}      ","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a strain with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/strains/:ucpc/reviews"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-16T15:30:49.419Z","editedParams":true,"editedParams2":true,"excerpt":"Get the reviews for a cannabis strain.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55232972e2de0a3500f0a2df","slug":"strains-ucpc-reviews","sync_unique":"","title":"/strains/:ucpc/reviews","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/:ucpc/reviews

Get the reviews for a cannabis strain.

Path Params

ucpc:
required
stringVUJCJ4TYMG000000000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the strain you would like reviews for.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":0,"_id":"552fd68ef99ae00d00e054d6","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/effectsFlavors","name":""}]},"params":[{"_id":"552fd68ef99ae00d00e054d7","default":"VUJCJ4TYMG000000000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the strain you'd like the effects and flavors for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": {\n        \"euphoria\": \"8.3333\",\n        \"creativity\": \"9.0000\",\n        \"calming\": \"6.0000\",\n        \"numbness\": \"7.6667\",\n        \"appetite_gain\": \"5.0000\",\n        \"dry_mouth\": \"5.0000\",\n        \"fruity\": \"5.0000\",\n        \"spicy\": \"5.5000\",\n        \"earthy\": \"5.5000\",\n        \"sour\": \"5.5000\",\n        \"sweet\": \"7.0000\",\n        \"pine\": \"4.0000\",\n        \"anxiety\": \"3.5000\",\n        \"reviews\": 3\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a strain with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/strains/:ucpc/effectsFlavors"},"body":"","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-16T15:34:38.512Z","editedParams":true,"editedParams2":true,"excerpt":"Get the average effects and flavors from reviews for this strain.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55232972e2de0a3500f0a2df","slug":"strains-ucpc-effectsflavors","sync_unique":"","title":"/strains/:ucpc/effectsFlavors","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/:ucpc/effectsFlavors

Get the average effects and flavors from reviews for this strain.

Path Params

ucpc:
required
stringVUJCJ4TYMG000000000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the strain you'd like the effects and flavors for.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"552fd7cdbfbc2f19007add76","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/seedCompany","name":""}]},"params":[{"_id":"552fd7cdbfbc2f19007add77","default":"VUJCJ4TYMG000000000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the strain you would like to find the [seed company](doc:seed-company-object) for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Sensi Seeds\",\n        \"ucpc\": \"VUJCJ00000000000000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/VUJCJ00000000000000000000\",\n        \"qr\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/qr-code.svg\",\n        \"url\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds\",\n        \"image\": \"https://www.cannabisreports.com/images/profile/1/full_15fda07a135540c1de6afbb38dafe2113a11a7a4.jpg\",\n        \"lineage\": {\n            \"Afghanistan\": \"AF\",\n            \"Canada\": \"CA\",\n            \"Colombia\": \"CO\",\n            \"Hungary\": \"HU\",\n            \"India\": \"IN\",\n            \"Indonesia\": \"ID\",\n            \"Jamaica\": \"JM\",\n            \"Malawi\": \"MW\",\n            \"Mexico\": \"MX\",\n            \"Nepal\": \"NP\",\n            \"Nigeria\": \"NG\",\n            \"Pakistan\": \"PK\",\n            \"Panama\": \"PA\",\n            \"South Africa\": \"ZA\",\n            \"Thailand\": \"TH\",\n            \"United States\": \"US\"\n        },\n        \"strains\": {\n            \"count\": 63,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/VUJCJ00000000000000000000/strains\"\n        },\n        \"reviews\": {\n            \"count\": 25,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/VUJCJ00000000000000000000/reviews\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2014-04-09 09:29:57\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-01-08 20:05:52\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a strain with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/strains/:ucpc/seedCompany"},"body":"","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-16T15:39:57.996Z","editedParams":true,"editedParams2":true,"excerpt":"Get the seed company that was responsible for a cannabis strain.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55232972e2de0a3500f0a2df","slug":"strains-ucpc-seedcompany","sync_unique":"","title":"/strains/:ucpc/seedCompany","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/:ucpc/seedCompany

Get the seed company that was responsible for a cannabis strain.

Path Params

ucpc:
required
stringVUJCJ4TYMG000000000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the strain you would like to find the [seed company](doc:seed-company-object) for.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"552ed81fa702770d00d96ef0","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/CYGU94JYKY000000000000000/genetics","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"CYGU94JYKY000000000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis strain you want information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Afghani No. 1\",\n            \"ucpc\": \"D4C6CMREWV000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/D4C6CMREWV000000000000000\",\n            \"qr\": \"https://www.cannabisreports.com/strain-reports/sacred-seeds/afghani-no-1/qr-code.svg\",\n            \"url\": \"https://www.cannabisreports.com/strain-reports/sacred-seeds/afghani-no-1\",\n            \"image\": \"https://www.cannabisreports.com/images/strains/landraces/full-afghani-no-1.png\",\n            \"seedCompany\": {\n                \"name\": \"Sacred Seeds\",\n                \"ucpc\": \"D4C6C00000000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/D4C6C00000000000000000000\"\n            },\n            \"genetics\": {\n                \"names\": \"Landraces\",\n                \"ucpc\": \"9XVU7R9C3R000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/D4C6CMREWV000000000000000/genetics\"\n            },\n            \"lineage\": {\n                \"Afghanistan\": \"AF\"\n            },\n            \"children\": {\n                \"count\": 19,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/D4C6CMREWV000000000000000/children\"\n            },\n            \"reviews\": {\n                \"count\": 1,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/D4C6CMREWV000000000000000/reviews\"\n            },\n            \"createdAt\": {\n                \"datetime\": \"2008-08-15 19:20:00\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-06-18 18:32:30\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ]\n}\n","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a strain with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/strains/:ucpc/genetics"},"body":"More information on how to read and understand cannabis genetics can be found in our FAQ:\n\nhttps://www.cannabisreports.com/faq/cannabis-genetics/how-do-you-read-cannabis-genetics\n\nThis goes up the genetic family tree looking for the parents of the strain. If you'd like to check out the children of a strain, see the documentation for [`/strain/:ucpc/children`](doc:strains-ucpc-children).","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-15T21:29:03.731Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the strains that were the parent material for the strain with the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55232972e2de0a3500f0a2df","slug":"strains-ucpc-genetics","sync_unique":"","title":"/strains/:ucpc/genetics","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/:ucpc/genetics

Gets the strains that were the parent material for the strain with the given UCPC.

Path Params

ucpc:
required
stringCYGU94JYKY000000000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis strain you want information about.
More information on how to read and understand cannabis genetics can be found in our FAQ: https://www.cannabisreports.com/faq/cannabis-genetics/how-do-you-read-cannabis-genetics This goes up the genetic family tree looking for the parents of the strain. If you'd like to check out the children of a strain, see the documentation for [`/strain/:ucpc/children`](doc:strains-ucpc-children).

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



More information on how to read and understand cannabis genetics can be found in our FAQ: https://www.cannabisreports.com/faq/cannabis-genetics/how-do-you-read-cannabis-genetics This goes up the genetic family tree looking for the parents of the strain. If you'd like to check out the children of a strain, see the documentation for [`/strain/:ucpc/children`](doc:strains-ucpc-children).
{"__v":0,"_id":"552ff3d1bfbc2f19007addaf","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/children","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"VUJCJ4TYMG000000000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis strain you want information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Jack Flash\",\n            \"ucpc\": \"VUJCJEZHC6000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJEZHC6000000000000000\",\n            \"qr\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-flash/qr-code.svg\",\n            \"url\": \"https://www.cannabisreports.com/strain-reports/sensi-seeds/jack-flash\",\n            \"image\": \"https://www.cannabisreports.com/images/strains/5/full_5b7bacfc57a26d02ba3f7ee85c46d70f845868ee.jpg\",\n            \"seedCompany\": {\n                \"name\": \"Sensi Seeds\",\n                \"ucpc\": \"VUJCJ00000000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/VUJCJ00000000000000000000\"\n            },\n            \"genetics\": {\n                \"names\": \"Jack Herer x (Super Skunk x Haze)\",\n                \"ucpc\": \"VUJCJ4TYMG000000000000000 x (2NGAWPEK4A000000000000000 x 9XVU7WJQCD000000000000000)\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJEZHC6000000000000000/genetics\"\n            },\n            \"lineage\": {\n                \"Afghanistan\": \"AF\",\n                \"Colombia\": \"CO\",\n                \"India\": \"IN\",\n                \"Mexico\": \"MX\",\n                \"Thailand\": \"TH\"\n            },\n            \"children\": {\n                \"count\": 3,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJEZHC6000000000000000/children\"\n            },\n            \"reviews\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJEZHC6000000000000000/reviews\"\n            },\n            \"createdAt\": {\n                \"datetime\": \"2008-08-15 19:20:00\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-06-07 13:04:14\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        { ... }\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 94,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 10,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/children?page=2\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a strain with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/strains/:ucpc/children"},"body":"This will provide a [paginated list](doc:pagination) of children that this strain was a parent of. Some strains have been bred into hundreds of other ones.\n\nFor the parents of this strain, check out the [`/strain/:ucpc/genetics`](doc:strains-ucpc-genetics) documentation.\n\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"55280d76456b9c170001a3eb","createdAt":"2015-04-16T17:39:29.836Z","editedParams":true,"editedParams2":true,"excerpt":"Get the child strains that this one has been bred into.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"55232972e2de0a3500f0a2df","slug":"strains-ucpc-children","sync_unique":"","title":"/strains/:ucpc/children","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/:ucpc/children

Get the child strains that this one has been bred into.

Path Params

ucpc:
required
stringVUJCJ4TYMG000000000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis strain you want information about.
This will provide a [paginated list](doc:pagination) of children that this strain was a parent of. Some strains have been bred into hundreds of other ones. For the parents of this strain, check out the [`/strain/:ucpc/genetics`](doc:strains-ucpc-genetics) documentation. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will provide a [paginated list](doc:pagination) of children that this strain was a parent of. Some strains have been bred into hundreds of other ones. For the parents of this strain, check out the [`/strain/:ucpc/genetics`](doc:strains-ucpc-genetics) documentation. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":0,"_id":"554a69e7156a480d00e2924c","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000/availability/geo/37.7749295/-122.4194155/10","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"VUJCJ4TYMG000000000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis strain you want availability for.","name":"ucpc","required":true,"type":"string","in":"path"},{"_id":"554a69e7156a480d00e2924f","required":true,"desc":"Latitude for the center of your availability search.","default":"37.7749295","type":"string","name":"lat","in":"path"},{"_id":"554a69e7156a480d00e2924e","required":true,"desc":"Longitude for the center of your availability search.","default":"-122.4194155","type":"string","name":"lng","in":"path"},{"_id":"554a69e7156a480d00e2924d","required":false,"desc":"Radius to search for in miles, max 25.","default":"10","type":"int","name":"radius","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Jack Herer\",\n            \"ucpc\": \"VUJCJ4TYMG000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\",\n            \"type\": \"strain\",\n            \"location\": {\n                \"name\": \"Love Shack Cooperative\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/love-shack-cooperative\",\n                \"lat\": \"37.7681384\",\n                \"lng\": \"-122.4246791\"\n            },\n            \"price\": null,\n            \"price_half_gram\": null,\n            \"price_gram\": \"10.00\",\n            \"price_eighth\": \"35.00\",\n            \"price_quarter\": \"70.00\",\n            \"price_half_ounce\": \"135.00\",\n            \"price_ounce\": \"265.00\",\n            \"createdAt\": {\n                \"datetime\": \"2014-05-20 18:31:40\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-05-21 04:56:23\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 10,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n} ","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a strain with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/strains/:ucpc/availability/geo/:lat/:lng/:radius"},"body":"This will provide a [paginated list](doc:pagination) of [item summary objects](doc:menu-item-summary-object) for this particular strain.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"55280d76456b9c170001a3eb","createdAt":"2015-05-06T19:22:15.202Z","editedParams":true,"editedParams2":true,"excerpt":"Get information about the availability of a strain using latitude and longitude.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":10,"project":"55232972e2de0a3500f0a2df","slug":"strains-ucpc-availability-geo-lat-lng-radius","sync_unique":"","title":"/strains/:ucpc/availability/geo/:lat/:lng/:radius","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/strains/:ucpc/availability/geo/:lat/:lng/:radius

Get information about the availability of a strain using latitude and longitude.

Path Params

ucpc:
required
stringVUJCJ4TYMG000000000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis strain you want availability for.
lat:
required
string37.7749295
Latitude for the center of your availability search.
lng:
required
string-122.4194155
Longitude for the center of your availability search.
radius:
integer10
Radius to search for in miles, max 25.
This will provide a [paginated list](doc:pagination) of [item summary objects](doc:menu-item-summary-object) for this particular strain. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will provide a [paginated list](doc:pagination) of [item summary objects](doc:menu-item-summary-object) for this particular strain. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":7,"_id":"56d5e46ec6473c0b00ba86d4","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis flowers are distinct products that can be found on retailer menus. The Cannabis Reports system allows for specific batches of cannabis flowers to be linked directly to the cultivator that grew the plant, while still maintaining a connection to the original genetics of the strain. Designating flowers as distinct items improves our ability to discuss the variety of flower quality that can be produced from the same strain grown at different farms.\n\nThe main forms of flowers that Cannabis Reports recognizes are:\n\n* [Flowers](https://www.cannabisreports.com/flower-reports/flowers)\n* [Seeds](https://www.cannabisreports.com/flower-reports/seeds)\n* [Clones](https://www.cannabisreports.com/flower-reports/clones)\n* [Shake](https://www.cannabisreports.com/flower-reports/shake)\n\nProducers measure the cannabinoid content of their flowers in many ways. Currently, Cannabis Reports allows producers to display the percentage of weight for [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) and [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol)\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"name\",\n    \"1-0\": \"ucpc\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`string`\",\n    \"0-2\": \"Name of the flower.\",\n    \"2-0\": \"link\",\n    \"2-1\": \"`url`\",\n    \"3-0\": \"qr\",\n    \"3-1\": \"`url`\",\n    \"4-0\": \"barcode\",\n    \"4-1\": \"`url`\",\n    \"5-0\": \"url\",\n    \"5-1\": \"`url`\",\n    \"6-0\": \"image\",\n    \"7-0\": \"producer\",\n    \"8-0\": \"producer.name\",\n    \"9-0\": \"producer.ucpc\",\n    \"10-0\": \"producer.link\",\n    \"11-0\": \"type\",\n    \"11-1\": \"`string`\",\n    \"7-1\": \"`object`\",\n    \"12-0\": \"strain\",\n    \"12-1\": \"`object`\",\n    \"13-0\": \"strain.name\",\n    \"14-0\": \"strain.ucpc\",\n    \"15-0\": \"strain.link\",\n    \"16-0\": \"labTest\",\n    \"17-0\": \"thc\",\n    \"18-0\": \"cbd\",\n    \"19-0\": \"reviews\",\n    \"20-0\": \"reviews.count\",\n    \"20-1\": \"`integer`\",\n    \"21-0\": \"reviews.link\",\n    \"22-0\": \"createdAt\",\n    \"23-0\": \"updatedAt\",\n    \"1-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) code for this flower.\",\n    \"2-2\": \"Link to the flower in the Cannabis Reports API.\",\n    \"3-2\": \"Link to the QR code for this flower.\",\n    \"4-2\": \"Link to the barcode for this flower.\",\n    \"5-2\": \"Link to the flower listing on the Cannabis Reports website.\",\n    \"6-1\": \"`url`\",\n    \"6-2\": \"Link to the full size image for this flower.\",\n    \"7-2\": \"Information about the [producer](doc:producer-object) that created the flower.\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"Name of the [producer](doc:producer-object) of the flower.\",\n    \"9-1\": \"`string`\",\n    \"9-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).\",\n    \"10-1\": \"`url`\",\n    \"10-2\": \"Link to the [producer](doc:producer-object) in the Cannabis Reports API.\",\n    \"11-2\": \"Type of cannabis flower.\",\n    \"12-2\": \"[Strain](doc:strain-object) that was used for this flower.\",\n    \"13-1\": \"`string`\",\n    \"13-2\": \"Name of the [strain](doc:strain-object) used for this flower.\",\n    \"14-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used for this flower.\",\n    \"14-1\": \"`string`\",\n    \"15-1\": \"`url`\",\n    \"15-2\": \"Link to the [strain](doc:strain-object) used in this flower in the Cannabis Reports API.\",\n    \"16-1\": \"`url`\",\n    \"16-2\": \"Link to the PDF containing lab test information for this flower.\",\n    \"17-1\": \"`string`\",\n    \"18-1\": \"`string`\",\n    \"17-2\": \"Percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this flower.\",\n    \"18-2\": \"Percentage of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this flower.\",\n    \"19-1\": \"`object`\",\n    \"19-2\": \"Object containing information on the reviews for the flower.\",\n    \"20-2\": \"Number of reviews for the flower.\",\n    \"21-1\": \"`url`\",\n    \"21-2\": \"Link to the reviews for the flower.\",\n    \"22-1\": \"`object`\",\n    \"22-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the flower was added.\",\n    \"23-1\": \"`object`\",\n    \"23-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the flower was updated.\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 24\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n        \\\"name\\\": \\\"The White - Flowers\\\",\\n        \\\"ucpc\\\": \\\"MQG4JYJX6W2WJVPEPP9X00000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/flowers/MQG4JYJX6W2WJVPEPP9X00000\\\",\\n        \\\"qr\\\": \\\"https://www.cannabisreports.com/flower-reports/qr-code/unknown-producer/krome/the-white/flowers.png\\\",\\n        \\\"barcode\\\": \\\"https://www.cannabisreports.com/flower-reports/barcode/unknown-producer/krome/the-white/flowers.png\\\",\\n        \\\"url\\\": \\\"https://www.cannabisreports.com/flower-reports/unknown-producer/krome/the-white/flowers\\\",\\n        \\\"image\\\": \\\"https://www.cannabisreports.com/images/strains/1/full_15176d2d4c37b8415e4042291e3e81b899d9ffe6.jpg\\\",\\n        \\\"producer\\\": {\\n            \\\"name\\\": \\\"Unknown Producer\\\",\\n            \\\"ucpc\\\": \\\"00000000002WJVP0000000000\\\",\\n            \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/00000000002WJVP0000000000\\\"\\n        },\\n        \\\"type\\\": \\\"flowers\\\",\\n        \\\"strain\\\": {\\n            \\\"name\\\": \\\"The White\\\",\\n            \\\"ucpc\\\": \\\"MQG4JYJX6W000000000000000\\\",\\n            \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/MQG4JYJX6W000000000000000\\\"\\n        },\\n        \\\"labTest\\\": false,\\n        \\\"thc\\\": false,\\n        \\\"cbd\\\": false,\\n        \\\"reviews\\\": {\\n            \\\"count\\\": 0,\\n            \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/flowers/MQG4JYJX6W2WJVPEPP9X00000/reviews\\\"\\n        },\\n        \\\"createdAt\\\": {\\n            \\\"datetime\\\": \\\"2016-02-12 04:56:02\\\",\\n            \\\"timezone\\\": \\\"UTC\\\"\\n        },\\n        \\\"updatedAt\\\": {\\n            \\\"datetime\\\": \\\"2016-02-12 04:56:02\\\",\\n            \\\"timezone\\\": \\\"UTC\\\"\\n        }\\n    }\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Explore Flower Endpoints\"\n}\n[/block]\nHere are some of the results available from the different flower endpoints:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint\",\n    \"h-1\": \"Result\",\n    \"0-0\": \"[/flowers](doc:flowers)\",\n    \"0-1\": \"Gets a paginated list of flowers with optional sorting.\",\n    \"1-0\": \"[/flowers/type/:flowerType](doc:flowers-type-flowertype)\",\n    \"1-1\": \"Gets a paginated list of products for a given type with optional sorting.\",\n    \"2-1\": \"Gets an individual flower based on the UCPC.\",\n    \"2-0\": \"[/flowers/:ucpc](doc:flowers-ucpc)\",\n    \"3-0\": \"[/flowers/:ucpc/reviews](doc:flowers-ucpc-reviews)\",\n    \"3-1\": \"Gets the reviews for a cannabis flower.\",\n    \"4-1\": \"Gets the average effects and flavors from reviews for this flower.\",\n    \"5-1\": \"Gets the producer for a given flower.\",\n    \"6-1\": \"Gets the information about a strain for a flower with the given UCPC.\",\n    \"7-1\": \"Get information about the availability of a flower using latitude and longitude.\",\n    \"4-0\": \"[/flowers/:ucpc/effectsFlavors](doc:flowers-ucpc-effectsflavors)\",\n    \"5-0\": \"[/flowers/:ucpc/producer](doc:flowers-ucpc-producer)\",\n    \"6-0\": \"[/flowers/:ucpc/strain](doc:flowers-ucpc-producer)\",\n    \"7-0\": \"[/flowers/:ucpc/availability/geo/:lat/:lng/:radius](doc:flowers-ucpc-availability-geo-lat-lng-radius)\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-01T18:50:22.088Z","excerpt":"Cannabis flowers in the Cannabis Reports system.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"flower-object","sync_unique":"","title":"Flower Object","type":"basic","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Flower Object

Cannabis flowers in the Cannabis Reports system.

Cannabis flowers are distinct products that can be found on retailer menus. The Cannabis Reports system allows for specific batches of cannabis flowers to be linked directly to the cultivator that grew the plant, while still maintaining a connection to the original genetics of the strain. Designating flowers as distinct items improves our ability to discuss the variety of flower quality that can be produced from the same strain grown at different farms. The main forms of flowers that Cannabis Reports recognizes are: * [Flowers](https://www.cannabisreports.com/flower-reports/flowers) * [Seeds](https://www.cannabisreports.com/flower-reports/seeds) * [Clones](https://www.cannabisreports.com/flower-reports/clones) * [Shake](https://www.cannabisreports.com/flower-reports/shake) Producers measure the cannabinoid content of their flowers in many ways. Currently, Cannabis Reports allows producers to display the percentage of weight for [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) and [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) [block:parameters] { "data": { "0-0": "name", "1-0": "ucpc", "0-1": "`string`", "1-1": "`string`", "0-2": "Name of the flower.", "2-0": "link", "2-1": "`url`", "3-0": "qr", "3-1": "`url`", "4-0": "barcode", "4-1": "`url`", "5-0": "url", "5-1": "`url`", "6-0": "image", "7-0": "producer", "8-0": "producer.name", "9-0": "producer.ucpc", "10-0": "producer.link", "11-0": "type", "11-1": "`string`", "7-1": "`object`", "12-0": "strain", "12-1": "`object`", "13-0": "strain.name", "14-0": "strain.ucpc", "15-0": "strain.link", "16-0": "labTest", "17-0": "thc", "18-0": "cbd", "19-0": "reviews", "20-0": "reviews.count", "20-1": "`integer`", "21-0": "reviews.link", "22-0": "createdAt", "23-0": "updatedAt", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this flower.", "2-2": "Link to the flower in the Cannabis Reports API.", "3-2": "Link to the QR code for this flower.", "4-2": "Link to the barcode for this flower.", "5-2": "Link to the flower listing on the Cannabis Reports website.", "6-1": "`url`", "6-2": "Link to the full size image for this flower.", "7-2": "Information about the [producer](doc:producer-object) that created the flower.", "8-1": "`string`", "8-2": "Name of the [producer](doc:producer-object) of the flower.", "9-1": "`string`", "9-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).", "10-1": "`url`", "10-2": "Link to the [producer](doc:producer-object) in the Cannabis Reports API.", "11-2": "Type of cannabis flower.", "12-2": "[Strain](doc:strain-object) that was used for this flower.", "13-1": "`string`", "13-2": "Name of the [strain](doc:strain-object) used for this flower.", "14-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used for this flower.", "14-1": "`string`", "15-1": "`url`", "15-2": "Link to the [strain](doc:strain-object) used in this flower in the Cannabis Reports API.", "16-1": "`url`", "16-2": "Link to the PDF containing lab test information for this flower.", "17-1": "`string`", "18-1": "`string`", "17-2": "Percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this flower.", "18-2": "Percentage of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this flower.", "19-1": "`object`", "19-2": "Object containing information on the reviews for the flower.", "20-2": "Number of reviews for the flower.", "21-1": "`url`", "21-2": "Link to the reviews for the flower.", "22-1": "`object`", "22-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the flower was added.", "23-1": "`object`", "23-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the flower was updated.", "h-0": "Name", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 24 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"The White - Flowers\",\n \"ucpc\": \"MQG4JYJX6W2WJVPEPP9X00000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/MQG4JYJX6W2WJVPEPP9X00000\",\n \"qr\": \"https://www.cannabisreports.com/flower-reports/qr-code/unknown-producer/krome/the-white/flowers.png\",\n \"barcode\": \"https://www.cannabisreports.com/flower-reports/barcode/unknown-producer/krome/the-white/flowers.png\",\n \"url\": \"https://www.cannabisreports.com/flower-reports/unknown-producer/krome/the-white/flowers\",\n \"image\": \"https://www.cannabisreports.com/images/strains/1/full_15176d2d4c37b8415e4042291e3e81b899d9ffe6.jpg\",\n \"producer\": {\n \"name\": \"Unknown Producer\",\n \"ucpc\": \"00000000002WJVP0000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000002WJVP0000000000\"\n },\n \"type\": \"flowers\",\n \"strain\": {\n \"name\": \"The White\",\n \"ucpc\": \"MQG4JYJX6W000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/MQG4JYJX6W000000000000000\"\n },\n \"labTest\": false,\n \"thc\": false,\n \"cbd\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/MQG4JYJX6W2WJVPEPP9X00000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2016-02-12 04:56:02\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2016-02-12 04:56:02\",\n \"timezone\": \"UTC\"\n }\n }", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Flower Endpoints" } [/block] Here are some of the results available from the different flower endpoints: [block:parameters] { "data": { "h-0": "Endpoint", "h-1": "Result", "0-0": "[/flowers](doc:flowers)", "0-1": "Gets a paginated list of flowers with optional sorting.", "1-0": "[/flowers/type/:flowerType](doc:flowers-type-flowertype)", "1-1": "Gets a paginated list of products for a given type with optional sorting.", "2-1": "Gets an individual flower based on the UCPC.", "2-0": "[/flowers/:ucpc](doc:flowers-ucpc)", "3-0": "[/flowers/:ucpc/reviews](doc:flowers-ucpc-reviews)", "3-1": "Gets the reviews for a cannabis flower.", "4-1": "Gets the average effects and flavors from reviews for this flower.", "5-1": "Gets the producer for a given flower.", "6-1": "Gets the information about a strain for a flower with the given UCPC.", "7-1": "Get information about the availability of a flower using latitude and longitude.", "4-0": "[/flowers/:ucpc/effectsFlavors](doc:flowers-ucpc-effectsflavors)", "5-0": "[/flowers/:ucpc/producer](doc:flowers-ucpc-producer)", "6-0": "[/flowers/:ucpc/strain](doc:flowers-ucpc-producer)", "7-0": "[/flowers/:ucpc/availability/geo/:lat/:lng/:radius](doc:flowers-ucpc-availability-geo-lat-lng-radius)" }, "cols": 2, "rows": 8 } [/block]
Cannabis flowers are distinct products that can be found on retailer menus. The Cannabis Reports system allows for specific batches of cannabis flowers to be linked directly to the cultivator that grew the plant, while still maintaining a connection to the original genetics of the strain. Designating flowers as distinct items improves our ability to discuss the variety of flower quality that can be produced from the same strain grown at different farms. The main forms of flowers that Cannabis Reports recognizes are: * [Flowers](https://www.cannabisreports.com/flower-reports/flowers) * [Seeds](https://www.cannabisreports.com/flower-reports/seeds) * [Clones](https://www.cannabisreports.com/flower-reports/clones) * [Shake](https://www.cannabisreports.com/flower-reports/shake) Producers measure the cannabinoid content of their flowers in many ways. Currently, Cannabis Reports allows producers to display the percentage of weight for [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) and [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) [block:parameters] { "data": { "0-0": "name", "1-0": "ucpc", "0-1": "`string`", "1-1": "`string`", "0-2": "Name of the flower.", "2-0": "link", "2-1": "`url`", "3-0": "qr", "3-1": "`url`", "4-0": "barcode", "4-1": "`url`", "5-0": "url", "5-1": "`url`", "6-0": "image", "7-0": "producer", "8-0": "producer.name", "9-0": "producer.ucpc", "10-0": "producer.link", "11-0": "type", "11-1": "`string`", "7-1": "`object`", "12-0": "strain", "12-1": "`object`", "13-0": "strain.name", "14-0": "strain.ucpc", "15-0": "strain.link", "16-0": "labTest", "17-0": "thc", "18-0": "cbd", "19-0": "reviews", "20-0": "reviews.count", "20-1": "`integer`", "21-0": "reviews.link", "22-0": "createdAt", "23-0": "updatedAt", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this flower.", "2-2": "Link to the flower in the Cannabis Reports API.", "3-2": "Link to the QR code for this flower.", "4-2": "Link to the barcode for this flower.", "5-2": "Link to the flower listing on the Cannabis Reports website.", "6-1": "`url`", "6-2": "Link to the full size image for this flower.", "7-2": "Information about the [producer](doc:producer-object) that created the flower.", "8-1": "`string`", "8-2": "Name of the [producer](doc:producer-object) of the flower.", "9-1": "`string`", "9-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).", "10-1": "`url`", "10-2": "Link to the [producer](doc:producer-object) in the Cannabis Reports API.", "11-2": "Type of cannabis flower.", "12-2": "[Strain](doc:strain-object) that was used for this flower.", "13-1": "`string`", "13-2": "Name of the [strain](doc:strain-object) used for this flower.", "14-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used for this flower.", "14-1": "`string`", "15-1": "`url`", "15-2": "Link to the [strain](doc:strain-object) used in this flower in the Cannabis Reports API.", "16-1": "`url`", "16-2": "Link to the PDF containing lab test information for this flower.", "17-1": "`string`", "18-1": "`string`", "17-2": "Percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this flower.", "18-2": "Percentage of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this flower.", "19-1": "`object`", "19-2": "Object containing information on the reviews for the flower.", "20-2": "Number of reviews for the flower.", "21-1": "`url`", "21-2": "Link to the reviews for the flower.", "22-1": "`object`", "22-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the flower was added.", "23-1": "`object`", "23-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the flower was updated.", "h-0": "Name", "h-1": "Type", "h-2": "Description" }, "cols": 3, "rows": 24 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"The White - Flowers\",\n \"ucpc\": \"MQG4JYJX6W2WJVPEPP9X00000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/MQG4JYJX6W2WJVPEPP9X00000\",\n \"qr\": \"https://www.cannabisreports.com/flower-reports/qr-code/unknown-producer/krome/the-white/flowers.png\",\n \"barcode\": \"https://www.cannabisreports.com/flower-reports/barcode/unknown-producer/krome/the-white/flowers.png\",\n \"url\": \"https://www.cannabisreports.com/flower-reports/unknown-producer/krome/the-white/flowers\",\n \"image\": \"https://www.cannabisreports.com/images/strains/1/full_15176d2d4c37b8415e4042291e3e81b899d9ffe6.jpg\",\n \"producer\": {\n \"name\": \"Unknown Producer\",\n \"ucpc\": \"00000000002WJVP0000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000002WJVP0000000000\"\n },\n \"type\": \"flowers\",\n \"strain\": {\n \"name\": \"The White\",\n \"ucpc\": \"MQG4JYJX6W000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/MQG4JYJX6W000000000000000\"\n },\n \"labTest\": false,\n \"thc\": false,\n \"cbd\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/MQG4JYJX6W2WJVPEPP9X00000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2016-02-12 04:56:02\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2016-02-12 04:56:02\",\n \"timezone\": \"UTC\"\n }\n }", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Flower Endpoints" } [/block] Here are some of the results available from the different flower endpoints: [block:parameters] { "data": { "h-0": "Endpoint", "h-1": "Result", "0-0": "[/flowers](doc:flowers)", "0-1": "Gets a paginated list of flowers with optional sorting.", "1-0": "[/flowers/type/:flowerType](doc:flowers-type-flowertype)", "1-1": "Gets a paginated list of products for a given type with optional sorting.", "2-1": "Gets an individual flower based on the UCPC.", "2-0": "[/flowers/:ucpc](doc:flowers-ucpc)", "3-0": "[/flowers/:ucpc/reviews](doc:flowers-ucpc-reviews)", "3-1": "Gets the reviews for a cannabis flower.", "4-1": "Gets the average effects and flavors from reviews for this flower.", "5-1": "Gets the producer for a given flower.", "6-1": "Gets the information about a strain for a flower with the given UCPC.", "7-1": "Get information about the availability of a flower using latitude and longitude.", "4-0": "[/flowers/:ucpc/effectsFlavors](doc:flowers-ucpc-effectsflavors)", "5-0": "[/flowers/:ucpc/producer](doc:flowers-ucpc-producer)", "6-0": "[/flowers/:ucpc/strain](doc:flowers-ucpc-producer)", "7-0": "[/flowers/:ucpc/availability/geo/:lat/:lng/:radius](doc:flowers-ucpc-availability-geo-lat-lng-radius)" }, "cols": 2, "rows": 8 } [/block]
{"__v":0,"_id":"56d62a18b30acf150053be46","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers?sort=-updatedAt&page=3"}]},"params":[{"_id":"56d62a18b30acf150053be48","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"56d62a18b30acf150053be47","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Key Lime Pie - Flowers\",\n            \"ucpc\": \"9XVU7FNY7ZMW2KZQTVNR00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/9XVU7FNY7ZMW2KZQTVNR00000\",\n            \"qr\": \"https://www.cannabisreports.com/flower-reports/qr-code/elevate-cannabis-co/unknown-breeder/key-lime-pie/flowers.png\",\n            \"barcode\": \"https://www.cannabisreports.com/flower-reports/barcode/elevate-cannabis-co/unknown-breeder/key-lime-pie/flowers.png\",\n            \"url\": \"https://www.cannabisreports.com/flower-reports/elevate-cannabis-co/unknown-breeder/key-lime-pie/flowers\",\n            \"image\": \"https://www.cannabisreports.com/images/flowers/d/full_d16466f2cf111e3d1ca524abd85e3e3eeeb51f1c.jpg\",\n            \"producer\": {\n                \"name\": \"Elevate Cannabis Co.\",\n                \"ucpc\": \"0000000000MW2KZ0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000MW2KZ0000000000\"\n            },\n            \"type\": \"flowers\",\n            \"strain\": {\n                \"name\": \"Key Lime Pie\",\n                \"ucpc\": \"9XVU7FNY7Z000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7FNY7Z000000000000000\"\n            },\n            \"labTest\": false,\n            \"thc\": \"22.23%\",\n            \"cbd\": \"0.22%\",\n            \"reviews\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/9XVU7FNY7ZMW2KZQTVNR00000/reviews\"\n            },\n            \"createdAt\": {\n                \"datetime\": \"2016-02-29 23:33:05\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2016-02-29 23:33:05\",\n                \"timezone\": \"UTC\"\n            }\n        },\n     \t\t{...}\n      ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 2288,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 229,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/flowers?sort=-updatedAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/flowers?sort=-updatedAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/flowers"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `flowers` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-01T23:47:36.323Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of flowers with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"flowers","sync_unique":"","title":"/flowers","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers

Gets a paginated list of flowers with optional sorting.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `flowers` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `flowers` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":1,"_id":"56d62a8c2417921500c4671f","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers/type/flowers?sort=-updatedAt&page=3"}]},"params":[{"_id":"56d62e19c6473c0b00ba8785","required":false,"desc":"The type of flowers you want to search through.","default":"flowers","type":"string","name":"flowerType","in":"path"},{"_id":"56d62e19c6473c0b00ba8784","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"56d62e19c6473c0b00ba8783","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Key Lime Pie - Flowers\",\n            \"ucpc\": \"9XVU7FNY7ZMW2KZQTVNR00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/9XVU7FNY7ZMW2KZQTVNR00000\",\n            \"qr\": \"https://www.cannabisreports.com/flower-reports/qr-code/elevate-cannabis-co/unknown-breeder/key-lime-pie/flowers.png\",\n            \"barcode\": \"https://www.cannabisreports.com/flower-reports/barcode/elevate-cannabis-co/unknown-breeder/key-lime-pie/flowers.png\",\n            \"url\": \"https://www.cannabisreports.com/flower-reports/elevate-cannabis-co/unknown-breeder/key-lime-pie/flowers\",\n            \"image\": \"https://www.cannabisreports.com/images/flowers/d/full_d16466f2cf111e3d1ca524abd85e3e3eeeb51f1c.jpg\",\n            \"producer\": {\n                \"name\": \"Elevate Cannabis Co.\",\n                \"ucpc\": \"0000000000MW2KZ0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000MW2KZ0000000000\"\n            },\n            \"type\": \"flowers\",\n            \"strain\": {\n                \"name\": \"Key Lime Pie\",\n                \"ucpc\": \"9XVU7FNY7Z000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7FNY7Z000000000000000\"\n            },\n            \"labTest\": false,\n            \"thc\": \"22.23%\",\n            \"cbd\": \"0.22%\",\n            \"reviews\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/9XVU7FNY7ZMW2KZQTVNR00000/reviews\"\n            },\n            \"createdAt\": {\n                \"datetime\": \"2016-02-29 23:33:05\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2016-02-29 23:33:05\",\n                \"timezone\": \"UTC\"\n            }\n        },\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 2284,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 229,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/flowers/type/flowers?sort=-updatedAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/flowers/type/flowers?sort=-updatedAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/flowers/type/:flowerType"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"flowerType\"\n}\n[/block]\nOne of the various types of products you would like to filter by. See the `Cannabis Flowers` definition for valid types.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `flowers` API. You can use the `page` argument to fetch the page of results you want.\n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-01T23:49:32.774Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of products for a given type with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"flowers-type-flowertype","sync_unique":"","title":"/flowers/type/:flowerType","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers/type/:flowerType

Gets a paginated list of products for a given type with optional sorting.

Path Params

flowerType:
stringflowers
The type of flowers you want to search through.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "flowerType" } [/block] One of the various types of products you would like to filter by. See the `Cannabis Flowers` definition for valid types. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `flowers` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "flowerType" } [/block] One of the various types of products you would like to filter by. See the `Cannabis Flowers` definition for valid types. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `flowers` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"56d63032b30acf150053be4d","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers/AHZ7H4N6467FVUDY3DAY00000"}]},"params":[{"_id":"56d63032b30acf150053be4e","required":false,"desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis flower you want information about.","default":"AHZ7H4N6467FVUDY3DAY00000","type":"string","name":"ucpc","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n        \"name\": \"Ogre Berry - Flowers\",\n        \"ucpc\": \"AHZ7H4N6467FVUDY3DAY00000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/AHZ7H4N6467FVUDY3DAY00000\",\n        \"qr\": \"https://www.cannabisreports.com/flower-reports/qr-code/happyday-farms/happyday-farms/ogre-berry-4/flowers.png\",\n        \"barcode\": \"https://www.cannabisreports.com/flower-reports/barcode/happyday-farms/happyday-farms/ogre-berry-4/flowers.png\",\n        \"url\": \"https://www.cannabisreports.com/flower-reports/happyday-farms/happyday-farms/ogre-berry-4/flowers\",\n        \"image\": \"https://www.cannabisreports.com/images/flowers/3/full_31ba360ff85eaa8b74e953a172c6408f6647abe2.jpg\",\n        \"producer\": {\n            \"name\": \"HappyDay Farms\",\n            \"ucpc\": \"00000000007FVUD0000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000007FVUD0000000000\"\n        },\n        \"type\": \"flowers\",\n        \"strain\": {\n            \"name\": \"Ogre Berry\",\n            \"ucpc\": \"9XVU74N646000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU74N646000000000000000\"\n        },\n        \"labTest\": false,\n        \"thc\": false,\n        \"cbd\": false,\n        \"reviews\": {\n            \"count\": 1,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/AHZ7H4N6467FVUDY3DAY00000/reviews\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2016-02-18 19:37:47\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2016-02-18 19:37:47\",\n            \"timezone\": \"UTC\"\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a flower with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/flowers/:ucpc"},"body":"","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-02T00:13:38.834Z","editedParams":true,"editedParams2":true,"excerpt":"Gets an individual flower based on the UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"flowers-ucpc","sync_unique":"","title":"/flowers/:ucpc","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers/:ucpc

Gets an individual flower based on the UCPC.

Path Params

ucpc:
stringAHZ7H4N6467FVUDY3DAY00000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis flower you want information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"56d630e1b30acf150053be52","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers/AHZ7H4N6467FVUDY3DAY00000/user"}]},"params":[{"_id":"56d630e1b30acf150053be53","required":false,"desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you want the user from.","default":"AHZ7H4N6467FVUDY3DAY00000","type":"string","name":"ucpc","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"nickname\": \"jbcrockett\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/users/jbcrockett\",\n        \"tagline\": \"Blazing the Alamo\",\n        \"url\": \"https://www.cannabisreports.com/profile/jbcrockett\",\n        \"slug\": \"jbcrockett\",\n        \"createdAt\": {\n            \"datetime\": \"2014-04-13 07:47:36\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2016-02-26 04:00:41\",\n            \"timezone\": \"UTC\"\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a flower with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/flowers/:ucpc/user"},"body":"","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-02T00:16:33.472Z","editedParams":true,"editedParams2":true,"excerpt":"Get the user who added the product to the database.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55232972e2de0a3500f0a2df","slug":"flowers-ucpc-user","sync_unique":"","title":"/flowers/:ucpc/user","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers/:ucpc/user

Get the user who added the product to the database.

Path Params

ucpc:
stringAHZ7H4N6467FVUDY3DAY00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you want the user from.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"56d63212c6473c0b00ba878b","api":{"examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers/AHZ7H4N6467FVUDY3DAY00000/reviews"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/reviews/cb17d26d7e877c5aa3060e285afbee22553a8119\",\n            \"url\": \"https://www.cannabisreports.com/smoke-reports/2016/03/01/cb17d26d7e877c5aa3060e285afbee22553a8119/jbcrockett\",\n            \"euphoria\": \"8\",\n            \"creativity\": \"10\",\n            \"pain_relief\": null,\n            \"appetite_gain\": \"6\",\n            \"calming\": \"4\",\n            \"anxiety\": null,\n            \"spicy\": null,\n            \"earthy\": \"2\",\n            \"fruity\": \"8\",\n            \"sour\": \"6\",\n            \"dry_mouth\": null,\n            \"createdAt\": {\n                \"datetime\": \"2016-03-01 23:36:32\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2016-03-01 23:36:32\",\n                \"timezone\": \"UTC\"\n            }\n        }\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 1,\n            \"count\": 1,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a flower with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","auth":"optional","params":[{"_id":"56d63212c6473c0b00ba878c","required":false,"desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the flower you would like reviews for.","default":"AHZ7H4N6467FVUDY3DAY00000","type":"string","name":"ucpc","in":"path"}],"url":"/flowers/:ucpc/reviews"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"Page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-02T00:21:38.027Z","editedParams":true,"editedParams2":true,"excerpt":"Get the reviews for a cannabis flower.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55232972e2de0a3500f0a2df","slug":"flowers-ucpc-reviews","sync_unique":"","title":"/flowers/:ucpc/reviews","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers/:ucpc/reviews

Get the reviews for a cannabis flower.

Path Params

ucpc:
stringAHZ7H4N6467FVUDY3DAY00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the flower you would like reviews for.
[block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":0,"_id":"56d6333cc6473c0b00ba8790","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers/AHZ7H4N6467FVUDY3DAY00000/effectsFlavors"}]},"params":[{"_id":"56d6333cc6473c0b00ba8791","required":false,"desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the flower you would like the effects and flavors for.","default":"AHZ7H4N6467FVUDY3DAY00000","type":"string","name":"ucpc","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"euphoria\": \"8.0000\",\n        \"creativity\": \"10.0000\",\n        \"calming\": \"4.0000\",\n        \"numbness\": \"4.0000\",\n        \"appetite_gain\": \"6.0000\",\n        \"dry_mouth\": \"6.0000\",\n        \"fruity\": \"8.0000\",\n        \"spicy\": null,\n        \"earthy\": \"2.0000\",\n        \"sour\": \"6.0000\",\n        \"sweet\": \"6.0000\",\n        \"pine\": null,\n        \"anxiety\": null,\n        \"reviews\": 1\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an edible with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/flowers/:ucpc/effectsFlavors"},"body":"","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-02T00:26:36.115Z","editedParams":true,"editedParams2":true,"excerpt":"Get the average effects and flavors from reviews for this flower.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55232972e2de0a3500f0a2df","slug":"flowers-ucpc-effectsFlavors","sync_unique":"","title":"/flowers/:ucpc/effectsFlavors","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers/:ucpc/effectsFlavors

Get the average effects and flavors from reviews for this flower.

Path Params

ucpc:
stringAHZ7H4N6467FVUDY3DAY00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the flower you would like the effects and flavors for.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"56d63411b30acf150053be56","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers/AHZ7H4N6467FVUDY3DAY00000/producer"}]},"params":[{"_id":"56d63411b30acf150053be57","required":false,"desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the flower you want the [producer](doc:producer-object) for.","default":"AHZ7H4N6467FVUDY3DAY00000","type":"string","name":"ucpc","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"HappyDay Farms\",\n        \"ucpc\": \"00000000007FVUD0000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000007FVUD0000000000\",\n        \"qr\": \"https://www.cannabisreports.com/producer-reports/happyday-farms/qr-code\",\n        \"url\": \"https://www.cannabisreports.com/producer-reports/happyday-farms\",\n        \"image\": \"https://www.cannabisreports.com/images/profile/4/full_4d36c17de8fbf6b27842e67ac36f6ff4ac60f6a0.jpg\",\n        \"reviews\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000007FVUD0000000000/reviews\"\n        },\n        \"extracts\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000007FVUD0000000000/extracts\"\n        },\n        \"edibles\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000007FVUD0000000000/edibles\"\n        },\n        \"products\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000007FVUD0000000000/products\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2016-02-18 19:36:19\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2016-02-18 19:36:47\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a flower with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/flowers/:ucpc/producer"},"body":"","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-02T00:30:09.532Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the producer for a given flower.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55232972e2de0a3500f0a2df","slug":"flowers-ucpc-producer","sync_unique":"","title":"/flowers/:ucpc/producer","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers/:ucpc/producer

Gets the producer for a given flower.

Path Params

ucpc:
stringAHZ7H4N6467FVUDY3DAY00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the flower you want the [producer](doc:producer-object) for.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"56d634ad2417921500c46731","api":{"examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers/AHZ7H4N6467FVUDY3DAY00000/strain"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Ogre Berry\",\n        \"ucpc\": \"9XVU74N646000000000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU74N646000000000000000\",\n        \"qr\": \"https://www.cannabisreports.com/strain-reports/happyday-farms/ogre-berry-4/qr-code.svg\",\n        \"url\": \"https://www.cannabisreports.com/strain-reports/happyday-farms/ogre-berry-4\",\n        \"image\": \"https://www.cannabisreports.com/images/strains/8/full_8dd6dbd49b15125172a96219086f81246e1ae15b.jpg\",\n        \"seedCompany\": {\n            \"name\": \"HappyDay Farms\",\n            \"ucpc\": \"AHZ7H00000000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/AHZ7H00000000000000000000\"\n        },\n        \"genetics\": {\n            \"names\": \"Ogre x Island Mountain Strawberry Afghani\",\n            \"ucpc\": \"9XVU7U9HUK000000000000000 x 9XVU7D492Z000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU74N646000000000000000/genetics\"\n        },\n        \"lineage\": [],\n        \"children\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU74N646000000000000000/children\"\n        },\n        \"reviews\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU74N646000000000000000/reviews\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2015-07-29 18:11:45\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-12-09 23:07:38\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a flower with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","auth":"optional","params":[{"_id":"56d634ad2417921500c46732","required":false,"desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the flower you want [strain](doc:strain-object) information about.","default":"AHZ7H4N6467FVUDY3DAY00000","type":"string","name":"ucpc","in":"path"}],"url":"/flowers/:ucpc/strain"},"body":"","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-02T00:32:45.269Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the information about a strain for a flower with the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55232972e2de0a3500f0a2df","slug":"flowers-ucpc-strain","sync_unique":"","title":"/flowers/:ucpc/strain","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers/:ucpc/strain

Gets the information about a strain for a flower with the given UCPC.

Path Params

ucpc:
stringAHZ7H4N6467FVUDY3DAY00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the flower you want [strain](doc:strain-object) information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"56d6367ec6473c0b00ba8794","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/flowers/YYRZDWGVU22WJVPGDJ7J00000/availability/geo/37.7749295/-122.4194155/25"}]},"params":[{"_id":"56d6367ec6473c0b00ba8798","required":false,"desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis flower you want availability for.","default":"YYRZDWGVU22WJVPGDJ7J00000","type":"string","name":"ucpc","in":"path"},{"_id":"56d6367ec6473c0b00ba8797","required":false,"desc":"Latitude for the center of your availability search.","default":"37.7749295","type":"string","name":"lat","in":"path"},{"_id":"56d6367ec6473c0b00ba8796","required":false,"desc":"Longitude for the center of your availability search.","default":"-122.4194155","type":"string","name":"lng","in":"path"},{"_id":"56d6367ec6473c0b00ba8795","required":false,"desc":"Radius to search for in miles, max 25.","default":"25","type":"string","name":"radius","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Harle-Tsu - Flowers\",\n            \"ucpc\": \"YYRZDWGVU22WJVPGDJ7J00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/flowers/YYRZDWGVU22WJVPGDJ7J00000\",\n            \"type\": \"flower\",\n            \"location\": {\n                \"name\": \"FeelGood\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/feelgood\",\n                \"lat\": \"37.7561438\",\n                \"lng\": \"-122.4325682\"\n            },\n            \"price\": null,\n            \"price_half_gram\": null,\n            \"price_gram\": \"0.00\",\n            \"price_eighth\": \"35.00\",\n            \"price_quarter\": \"65.00\",\n            \"price_half_ounce\": \"120.00\",\n            \"price_ounce\": \"220.00\",\n            \"createdAt\": {\n                \"datetime\": \"2014-07-11 01:27:51\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-07-11 01:35:24\",\n                \"timezone\": \"UTC\"\n            }\n        },\n     \t  {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 2,\n            \"count\": 2,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a product with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/flowers/:ucpc/availability/geo/:lat/:lng/:radius"},"body":"","category":"56d5dbb6c6473c0b00ba86a7","createdAt":"2016-03-02T00:40:30.054Z","editedParams":true,"editedParams2":true,"excerpt":"Get information about the availability of a product using latitude and longitude.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"55232972e2de0a3500f0a2df","slug":"flowers-ucpc-availability-geo-lat-lng-radius","sync_unique":"","title":"/flowers/:ucpc/availability/geo/:lat/:long/:radius","type":"get","updates":[],"user":"55493bb86a82a10d00817aa2","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/flowers/:ucpc/availability/geo/:lat/:long/:radius

Get information about the availability of a product using latitude and longitude.

Path Params

ucpc:
stringYYRZDWGVU22WJVPGDJ7J00000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis flower you want availability for.
lat:
string37.7749295
Latitude for the center of your availability search.
lng:
string-122.4194155
Longitude for the center of your availability search.
radius:
string25
Radius to search for in miles, max 25.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":21,"_id":"55352e9349945b0d00cb4dfc","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis extracts are created from the flowers of the cannabis plant. Various methods for creating cannabis extracts have been perfected over thousands of years.\n\nCannabis Reports recognizes 10 main types of extracts:\n\n* [Kief](https://www.cannabisreports.com/extract-reports/kief)\n* [Hash](https://www.cannabisreports.com/extract-reports/hash)\n* [Water-Hash](https://www.cannabisreports.com/extract-reports/water-hash)\n* [Oil](https://www.cannabisreports.com/extract-reports/oil)\n* [Wax](https://www.cannabisreports.com/extract-reports/wax)\n* [Crumble](https://www.cannabisreports.com/extract-reports/crumble)\n* [Honeycomb](https://www.cannabisreports.com/extract-reports/honeycomb)\n* [Shatter](https://www.cannabisreports.com/extract-reports/shatter)\n* [Vaporizer-Disposable](https://www.cannabisreports.com/extract-reports/vaporizer-disposable)\n* [Vaporizer-Cartridge](https://www.cannabisreports.com/extract-reports/vaporizer-cartridge)\n\nEach extract is tied to a [strain](doc:strain-object) and the [producer](doc:producer-object) who created it. For more information about cannabis extracts, check out our FAQ here:\n\nhttps://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-extract\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Extract Attributes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Name of the extract including the name of the [strain](doc:strain-object) and the type of extract.\",\n    \"1-0\": \"ucpc\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) code for this extract.\",\n    \"2-0\": \"link\",\n    \"2-1\": \"`url`\",\n    \"2-2\": \"Link to the extract in the Cannabis Reports API.\",\n    \"3-0\": \"qr\",\n    \"3-1\": \"`url`\",\n    \"3-2\": \"Link to the QR code for this extract.\",\n    \"5-0\": \"url\",\n    \"5-1\": \"`url`\",\n    \"5-2\": \"Link to the extract listing on the Cannabis Reports website.\",\n    \"7-0\": \"producer\",\n    \"7-1\": \"`object`\",\n    \"7-2\": \"Information about the [producer](doc:producer-object) that created the extract.\",\n    \"8-0\": \"producer.name\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"Name of the [producer](doc:producer-object) of the extract.\",\n    \"9-0\": \"producer.ucpc\",\n    \"9-1\": \"`string`\",\n    \"9-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).\",\n    \"10-0\": \"producer.link\",\n    \"10-1\": \"`url`\",\n    \"10-2\": \"Link to the [producer](doc:producer-object) in the Cannabis Reports API.\",\n    \"20-0\": \"reviews.count\",\n    \"20-1\": \"`integer`\",\n    \"20-2\": \"Number of reviews for the extract.\",\n    \"22-0\": \"createdAt\",\n    \"22-1\": \"`object`\",\n    \"22-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the extract was added.\",\n    \"23-0\": \"updatedAt\",\n    \"23-1\": \"`object`\",\n    \"23-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the extract was updated.\",\n    \"12-0\": \"strain\",\n    \"12-1\": \"`object`\",\n    \"12-2\": \"[Strain](doc:strain-object) that this extract comes from.\",\n    \"13-0\": \"strain.name\",\n    \"13-1\": \"`string`\",\n    \"13-2\": \"Name of the [strain](doc:strain-object) this extract comes from.\",\n    \"14-0\": \"strain.ucpc\",\n    \"14-1\": \"`string`\",\n    \"14-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) this extract comes from.\",\n    \"15-0\": \"strain.link\",\n    \"15-1\": \"`url`\",\n    \"15-2\": \"Link to the [strain](doc:strain-object) this extract comes from in the Cannabis Reports API.\",\n    \"16-0\": \"labTest\",\n    \"16-1\": \"`url`\",\n    \"16-2\": \"Link to the PDF containing lab test information for this extract.\",\n    \"17-0\": \"thc\",\n    \"17-1\": \"`string`\",\n    \"17-2\": \"Percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this extract.\",\n    \"18-0\": \"cbd\",\n    \"18-1\": \"`string`\",\n    \"18-2\": \"Percentage of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this extract.\",\n    \"6-0\": \"image\",\n    \"6-1\": \"`url`\",\n    \"6-2\": \"Link to the full size image for this extract. If none has been uploaded, this links to a generic image for this type of extract.\",\n    \"4-0\": \"barcode\",\n    \"4-1\": \"`url`\",\n    \"4-2\": \"Link to the barcode for this extract.\",\n    \"11-0\": \"type\",\n    \"11-2\": \"Type of cannabis extract.\",\n    \"11-1\": \"`string`\",\n    \"21-0\": \"reviews.link\",\n    \"21-1\": \"`url`\",\n    \"21-2\": \"Link to the reviews for the extract.\",\n    \"19-0\": \"reviews\",\n    \"19-1\": \"`object`\",\n    \"19-2\": \"Object containing information on the reviews for the extract.\"\n  },\n  \"cols\": 3,\n  \"rows\": 24\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"AK-47 - Vaporizer Disposable\\\",\\n    \\\"ucpc\\\": \\\"CYGU94JYKYUY9V7TAFL200000\\\",\\n    \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000\\\",\\n    \\\"qr\\\": \\\"https://www.cannabisreports.com/extract-reports/qr-code/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\\\",\\n    \\\"barcode\\\": \\\"https://www.cannabisreports.com/extract-reports/barcode/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\\\",\\n    \\\"url\\\": \\\"https://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable\\\",\\n    \\\"image\\\": \\\"https://www.cannabisreports.com/images/extracts/e/full_ef59374e7687e59184f4860e1720a1f908f03bf1.jpg\\\",\\n    \\\"producer\\\": {\\n        \\\"name\\\": \\\"BumbleBee\\\",\\n        \\\"ucpc\\\": \\\"0000000000UY9V70000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000UY9V70000000000\\\"\\n    },\\n    \\\"type\\\": \\\"vaporizer disposable\\\",\\n    \\\"strain\\\": {\\n        \\\"name\\\": \\\"AK-47\\\",\\n        \\\"ucpc\\\": \\\"CYGU94JYKY000000000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/CYGU94JYKY000000000000000\\\"\\n    },\\n    \\\"labTest\\\": false,\\n    \\\"thc\\\": false,\\n    \\\"cbd\\\": false,\\n    \\\"reviews\\\": {\\n        \\\"count\\\": 0,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000/reviews\\\"\\n    },\\n    \\\"createdAt\\\": {\\n        \\\"datetime\\\": \\\"2014-12-02 22:58:19\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    },\\n    \\\"updatedAt\\\": {\\n        \\\"datetime\\\": \\\"2014-12-02 22:58:19\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Explore Extract Endpoints\"\n}\n[/block]\nHere are some of the results available from the different extract endpoints\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"[/extracts](doc:extracts)\",\n    \"0-1\": \"Gets a paginated list of extracts with optional sorting.\",\n    \"1-0\": \"[/extracts/type/:extractType](doc:extracts-type-extracttype)\",\n    \"1-1\": \"Gets a paginated list of extracts with optional sorting.\",\n    \"2-0\": \"[/extracts/:ucpc](doc:extracts-ucpc)\",\n    \"2-1\": \"Gets an individual extract based on the UCPC.\",\n    \"3-0\": \"[/extracts/:ucpc/reviews](doc:extracts-ucpc-reviews)\",\n    \"3-1\": \"Get the reviews for a cannabis extract.\",\n    \"4-0\": \"[/extracts/:ucpc/effectsFlavors](doc:extracts-ucpc-effectsflavors)\",\n    \"4-1\": \"Get the average effects and flavors from reviews for this extract.\",\n    \"5-1\": \"Gets the producer for a given extract.\",\n    \"5-0\": \"[/extracts/:ucpc/producer](doc:extracts-ucpc-producer)\",\n    \"6-0\": \"[/extracts/:ucpc/strain](doc:extracts-ucpc-strain)\",\n    \"6-1\": \"Gets the information about a strain for an extract with the given UCPC.\",\n    \"7-0\": \"[/extracts/:ucpc/availability/geo/:lat/:lng/:radius](doc:extracts-ucpc-availability-geo-lat-lng-radius)\",\n    \"7-1\": \"Get information about the availability of an extract using latitude and longitude.\",\n    \"h-0\": \"Endpoint\",\n    \"h-1\": \"Result\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-20T16:51:31.789Z","excerpt":"Cannabis extracts in the Cannabis Reports system.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"extract-object","sync_unique":"","title":"Extract Object","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Extract Object

Cannabis extracts in the Cannabis Reports system.

Cannabis extracts are created from the flowers of the cannabis plant. Various methods for creating cannabis extracts have been perfected over thousands of years. Cannabis Reports recognizes 10 main types of extracts: * [Kief](https://www.cannabisreports.com/extract-reports/kief) * [Hash](https://www.cannabisreports.com/extract-reports/hash) * [Water-Hash](https://www.cannabisreports.com/extract-reports/water-hash) * [Oil](https://www.cannabisreports.com/extract-reports/oil) * [Wax](https://www.cannabisreports.com/extract-reports/wax) * [Crumble](https://www.cannabisreports.com/extract-reports/crumble) * [Honeycomb](https://www.cannabisreports.com/extract-reports/honeycomb) * [Shatter](https://www.cannabisreports.com/extract-reports/shatter) * [Vaporizer-Disposable](https://www.cannabisreports.com/extract-reports/vaporizer-disposable) * [Vaporizer-Cartridge](https://www.cannabisreports.com/extract-reports/vaporizer-cartridge) Each extract is tied to a [strain](doc:strain-object) and the [producer](doc:producer-object) who created it. For more information about cannabis extracts, check out our FAQ here: https://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-extract [block:api-header] { "type": "basic", "title": "Extract Attributes" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the extract including the name of the [strain](doc:strain-object) and the type of extract.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this extract.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the extract in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this extract.", "5-0": "url", "5-1": "`url`", "5-2": "Link to the extract listing on the Cannabis Reports website.", "7-0": "producer", "7-1": "`object`", "7-2": "Information about the [producer](doc:producer-object) that created the extract.", "8-0": "producer.name", "8-1": "`string`", "8-2": "Name of the [producer](doc:producer-object) of the extract.", "9-0": "producer.ucpc", "9-1": "`string`", "9-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).", "10-0": "producer.link", "10-1": "`url`", "10-2": "Link to the [producer](doc:producer-object) in the Cannabis Reports API.", "20-0": "reviews.count", "20-1": "`integer`", "20-2": "Number of reviews for the extract.", "22-0": "createdAt", "22-1": "`object`", "22-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the extract was added.", "23-0": "updatedAt", "23-1": "`object`", "23-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the extract was updated.", "12-0": "strain", "12-1": "`object`", "12-2": "[Strain](doc:strain-object) that this extract comes from.", "13-0": "strain.name", "13-1": "`string`", "13-2": "Name of the [strain](doc:strain-object) this extract comes from.", "14-0": "strain.ucpc", "14-1": "`string`", "14-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) this extract comes from.", "15-0": "strain.link", "15-1": "`url`", "15-2": "Link to the [strain](doc:strain-object) this extract comes from in the Cannabis Reports API.", "16-0": "labTest", "16-1": "`url`", "16-2": "Link to the PDF containing lab test information for this extract.", "17-0": "thc", "17-1": "`string`", "17-2": "Percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this extract.", "18-0": "cbd", "18-1": "`string`", "18-2": "Percentage of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this extract.", "6-0": "image", "6-1": "`url`", "6-2": "Link to the full size image for this extract. If none has been uploaded, this links to a generic image for this type of extract.", "4-0": "barcode", "4-1": "`url`", "4-2": "Link to the barcode for this extract.", "11-0": "type", "11-2": "Type of cannabis extract.", "11-1": "`string`", "21-0": "reviews.link", "21-1": "`url`", "21-2": "Link to the reviews for the extract.", "19-0": "reviews", "19-1": "`object`", "19-2": "Object containing information on the reviews for the extract." }, "cols": 3, "rows": 24 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"AK-47 - Vaporizer Disposable\",\n \"ucpc\": \"CYGU94JYKYUY9V7TAFL200000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000\",\n \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\",\n \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\",\n \"url\": \"https://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable\",\n \"image\": \"https://www.cannabisreports.com/images/extracts/e/full_ef59374e7687e59184f4860e1720a1f908f03bf1.jpg\",\n \"producer\": {\n \"name\": \"BumbleBee\",\n \"ucpc\": \"0000000000UY9V70000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000UY9V70000000000\"\n },\n \"type\": \"vaporizer disposable\",\n \"strain\": {\n \"name\": \"AK-47\",\n \"ucpc\": \"CYGU94JYKY000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/CYGU94JYKY000000000000000\"\n },\n \"labTest\": false,\n \"thc\": false,\n \"cbd\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2014-12-02 22:58:19\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2014-12-02 22:58:19\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Extract Endpoints" } [/block] Here are some of the results available from the different extract endpoints [block:parameters] { "data": { "0-0": "[/extracts](doc:extracts)", "0-1": "Gets a paginated list of extracts with optional sorting.", "1-0": "[/extracts/type/:extractType](doc:extracts-type-extracttype)", "1-1": "Gets a paginated list of extracts with optional sorting.", "2-0": "[/extracts/:ucpc](doc:extracts-ucpc)", "2-1": "Gets an individual extract based on the UCPC.", "3-0": "[/extracts/:ucpc/reviews](doc:extracts-ucpc-reviews)", "3-1": "Get the reviews for a cannabis extract.", "4-0": "[/extracts/:ucpc/effectsFlavors](doc:extracts-ucpc-effectsflavors)", "4-1": "Get the average effects and flavors from reviews for this extract.", "5-1": "Gets the producer for a given extract.", "5-0": "[/extracts/:ucpc/producer](doc:extracts-ucpc-producer)", "6-0": "[/extracts/:ucpc/strain](doc:extracts-ucpc-strain)", "6-1": "Gets the information about a strain for an extract with the given UCPC.", "7-0": "[/extracts/:ucpc/availability/geo/:lat/:lng/:radius](doc:extracts-ucpc-availability-geo-lat-lng-radius)", "7-1": "Get information about the availability of an extract using latitude and longitude.", "h-0": "Endpoint", "h-1": "Result" }, "cols": 2, "rows": 8 } [/block]
Cannabis extracts are created from the flowers of the cannabis plant. Various methods for creating cannabis extracts have been perfected over thousands of years. Cannabis Reports recognizes 10 main types of extracts: * [Kief](https://www.cannabisreports.com/extract-reports/kief) * [Hash](https://www.cannabisreports.com/extract-reports/hash) * [Water-Hash](https://www.cannabisreports.com/extract-reports/water-hash) * [Oil](https://www.cannabisreports.com/extract-reports/oil) * [Wax](https://www.cannabisreports.com/extract-reports/wax) * [Crumble](https://www.cannabisreports.com/extract-reports/crumble) * [Honeycomb](https://www.cannabisreports.com/extract-reports/honeycomb) * [Shatter](https://www.cannabisreports.com/extract-reports/shatter) * [Vaporizer-Disposable](https://www.cannabisreports.com/extract-reports/vaporizer-disposable) * [Vaporizer-Cartridge](https://www.cannabisreports.com/extract-reports/vaporizer-cartridge) Each extract is tied to a [strain](doc:strain-object) and the [producer](doc:producer-object) who created it. For more information about cannabis extracts, check out our FAQ here: https://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-extract [block:api-header] { "type": "basic", "title": "Extract Attributes" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the extract including the name of the [strain](doc:strain-object) and the type of extract.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this extract.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the extract in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this extract.", "5-0": "url", "5-1": "`url`", "5-2": "Link to the extract listing on the Cannabis Reports website.", "7-0": "producer", "7-1": "`object`", "7-2": "Information about the [producer](doc:producer-object) that created the extract.", "8-0": "producer.name", "8-1": "`string`", "8-2": "Name of the [producer](doc:producer-object) of the extract.", "9-0": "producer.ucpc", "9-1": "`string`", "9-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).", "10-0": "producer.link", "10-1": "`url`", "10-2": "Link to the [producer](doc:producer-object) in the Cannabis Reports API.", "20-0": "reviews.count", "20-1": "`integer`", "20-2": "Number of reviews for the extract.", "22-0": "createdAt", "22-1": "`object`", "22-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the extract was added.", "23-0": "updatedAt", "23-1": "`object`", "23-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the extract was updated.", "12-0": "strain", "12-1": "`object`", "12-2": "[Strain](doc:strain-object) that this extract comes from.", "13-0": "strain.name", "13-1": "`string`", "13-2": "Name of the [strain](doc:strain-object) this extract comes from.", "14-0": "strain.ucpc", "14-1": "`string`", "14-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) this extract comes from.", "15-0": "strain.link", "15-1": "`url`", "15-2": "Link to the [strain](doc:strain-object) this extract comes from in the Cannabis Reports API.", "16-0": "labTest", "16-1": "`url`", "16-2": "Link to the PDF containing lab test information for this extract.", "17-0": "thc", "17-1": "`string`", "17-2": "Percentage of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this extract.", "18-0": "cbd", "18-1": "`string`", "18-2": "Percentage of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this extract.", "6-0": "image", "6-1": "`url`", "6-2": "Link to the full size image for this extract. If none has been uploaded, this links to a generic image for this type of extract.", "4-0": "barcode", "4-1": "`url`", "4-2": "Link to the barcode for this extract.", "11-0": "type", "11-2": "Type of cannabis extract.", "11-1": "`string`", "21-0": "reviews.link", "21-1": "`url`", "21-2": "Link to the reviews for the extract.", "19-0": "reviews", "19-1": "`object`", "19-2": "Object containing information on the reviews for the extract." }, "cols": 3, "rows": 24 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"AK-47 - Vaporizer Disposable\",\n \"ucpc\": \"CYGU94JYKYUY9V7TAFL200000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000\",\n \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\",\n \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/bumblebee/serious-seeds/ak-47/vaporizer-disposable.png\",\n \"url\": \"https://www.cannabisreports.com/extract-reports/bumblebee/serious-seeds/ak-47/vaporizer-disposable\",\n \"image\": \"https://www.cannabisreports.com/images/extracts/e/full_ef59374e7687e59184f4860e1720a1f908f03bf1.jpg\",\n \"producer\": {\n \"name\": \"BumbleBee\",\n \"ucpc\": \"0000000000UY9V70000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000UY9V70000000000\"\n },\n \"type\": \"vaporizer disposable\",\n \"strain\": {\n \"name\": \"AK-47\",\n \"ucpc\": \"CYGU94JYKY000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/CYGU94JYKY000000000000000\"\n },\n \"labTest\": false,\n \"thc\": false,\n \"cbd\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/CYGU94JYKYUY9V7TAFL200000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2014-12-02 22:58:19\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2014-12-02 22:58:19\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Extract Endpoints" } [/block] Here are some of the results available from the different extract endpoints [block:parameters] { "data": { "0-0": "[/extracts](doc:extracts)", "0-1": "Gets a paginated list of extracts with optional sorting.", "1-0": "[/extracts/type/:extractType](doc:extracts-type-extracttype)", "1-1": "Gets a paginated list of extracts with optional sorting.", "2-0": "[/extracts/:ucpc](doc:extracts-ucpc)", "2-1": "Gets an individual extract based on the UCPC.", "3-0": "[/extracts/:ucpc/reviews](doc:extracts-ucpc-reviews)", "3-1": "Get the reviews for a cannabis extract.", "4-0": "[/extracts/:ucpc/effectsFlavors](doc:extracts-ucpc-effectsflavors)", "4-1": "Get the average effects and flavors from reviews for this extract.", "5-1": "Gets the producer for a given extract.", "5-0": "[/extracts/:ucpc/producer](doc:extracts-ucpc-producer)", "6-0": "[/extracts/:ucpc/strain](doc:extracts-ucpc-strain)", "6-1": "Gets the information about a strain for an extract with the given UCPC.", "7-0": "[/extracts/:ucpc/availability/geo/:lat/:lng/:radius](doc:extracts-ucpc-availability-geo-lat-lng-radius)", "7-1": "Get information about the availability of an extract using latitude and longitude.", "h-0": "Endpoint", "h-1": "Result" }, "cols": 2, "rows": 8 } [/block]
{"__v":0,"_id":"55351c57f07d6b0d0077be49","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts?sort=-updatedAt&page=3"}]},"params":[{"_id":"552c3ee10b701a1700470d86","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"552c3fc1d9f89e0d0015a5b3","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Plane Wreck - Wax\",\n            \"ucpc\": \"9XVU7GY6KE2WJVPYV3VX00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/9XVU7GY6KE2WJVPYV3VX00000\",\n            \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/unknown-producer/unknown-breeder/plane-wreck/wax.png\",\n            \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/unknown-producer/unknown-breeder/plane-wreck/wax.png\",\n            \"url\": \"https://www.cannabisreports.com/extract-reports/unknown-producer/unknown-breeder/plane-wreck/wax\",\n            \"image\": \"https://www.cannabisreports.com/images/extracts/wax.jpg\",\n            \"producer\": {\n                \"name\": \"Unknown Producer\",\n                \"ucpc\": \"00000000002WJVP0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000002WJVP0000000000\"\n            },\n            \"type\": \"wax\",\n            \"strain\": {\n                \"name\": \"Plane Wreck\",\n                \"ucpc\": \"9XVU7GY6KE000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7GY6KE000000000000000\"\n            },\n            \"labTest\": false,\n            \"thc\": false,\n            \"cbd\": false,\n            \"reviews\": 0,\n            \"createdAt\": {\n                \"datetime\": \"2015-05-06 21:25:47\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-05-06 21:25:48\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 3852,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 386,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/extracts?sort=-updatedAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/extracts?sort=-updatedAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/extracts"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for more information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-20T15:33:43.911Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of extracts with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"extracts","sync_unique":"","title":"/extracts","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts

Gets a paginated list of extracts with optional sorting.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"5536cabe8bb21f0d006f5d36","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts/type/shatter?sort=-updatedAt&page=3"}]},"params":[{"_id":"5536cabe8bb21f0d006f5d37","default":"shatter","desc":"The type of extract you want to search through.","name":"extractType","required":true,"type":"string","in":"path"},{"_id":"552c3ee10b701a1700470d86","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"552c3fc1d9f89e0d0015a5b3","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Sour Diesel - Shatter\",\n            \"ucpc\": \"9XVU7KVPFZTMVC3L4Z4900000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/9XVU7KVPFZTMVC3L4Z4900000\",\n            \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/flower-of-life-extracts/unknown-breeder/sour-diesel/shatter.png\",\n            \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/flower-of-life-extracts/unknown-breeder/sour-diesel/shatter.png\",\n            \"url\": \"https://www.cannabisreports.com/extract-reports/flower-of-life-extracts/unknown-breeder/sour-diesel/shatter\",\n            \"image\": \"https://www.cannabisreports.com/images/extracts/c/full_cfcf09cc1e10f751fa52226ac4a7a52f138459d4.jpg\",\n            \"producer\": {\n                \"name\": \"Flower of Life Extracts\",\n                \"ucpc\": \"0000000000TMVC30000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000TMVC30000000000\"\n            },\n            \"type\": \"shatter\",\n            \"strain\": {\n                \"name\": \"Sour Diesel\",\n                \"ucpc\": \"9XVU7KVPFZ000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7KVPFZ000000000000000\"\n            },\n            \"labTest\": false,\n            \"thc\": false,\n            \"cbd\": false,\n            \"reviews\": 0,\n            \"createdAt\": {\n                \"datetime\": \"2015-05-06 18:08:22\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-05-06 18:08:22\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 909,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 91,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/extracts/type/shatter?sort=-updatedAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/extracts/type/shatter?sort=-updatedAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/extracts/type/:extractType"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"extractType\"\n}\n[/block]\nOne of the various types of extracts you would like to filter by. Acceptable types are:\n\n* [Kief](https://www.cannabisreports.com/extract-reports/kief)\n* [Hash](https://www.cannabisreports.com/extract-reports/hash)\n* [Water-Hash](https://www.cannabisreports.com/extract-reports/water-hash)\n* [Oil](https://www.cannabisreports.com/extract-reports/oil)\n* [Wax](https://www.cannabisreports.com/extract-reports/wax)\n* [Crumble](https://www.cannabisreports.com/extract-reports/crumble)\n* [Honeycomb](https://www.cannabisreports.com/extract-reports/honeycomb)\n* [Shatter](https://www.cannabisreports.com/extract-reports/shatter)\n* [Vaporizer-Disposable](https://www.cannabisreports.com/extract-reports/vaporizer-disposable)\n* [Vaporizer-Cartridge](https://www.cannabisreports.com/extract-reports/vaporizer-cartridge)\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for more information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-21T22:10:06.291Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of extracts with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"extracts-type-extracttype","sync_unique":"","title":"/extracts/type/:extractType","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts/type/:extractType

Gets a paginated list of extracts with optional sorting.

Path Params

extractType:
required
stringshatter
The type of extract you want to search through.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "extractType" } [/block] One of the various types of extracts you would like to filter by. Acceptable types are: * [Kief](https://www.cannabisreports.com/extract-reports/kief) * [Hash](https://www.cannabisreports.com/extract-reports/hash) * [Water-Hash](https://www.cannabisreports.com/extract-reports/water-hash) * [Oil](https://www.cannabisreports.com/extract-reports/oil) * [Wax](https://www.cannabisreports.com/extract-reports/wax) * [Crumble](https://www.cannabisreports.com/extract-reports/crumble) * [Honeycomb](https://www.cannabisreports.com/extract-reports/honeycomb) * [Shatter](https://www.cannabisreports.com/extract-reports/shatter) * [Vaporizer-Disposable](https://www.cannabisreports.com/extract-reports/vaporizer-disposable) * [Vaporizer-Cartridge](https://www.cannabisreports.com/extract-reports/vaporizer-cartridge) [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "extractType" } [/block] One of the various types of extracts you would like to filter by. Acceptable types are: * [Kief](https://www.cannabisreports.com/extract-reports/kief) * [Hash](https://www.cannabisreports.com/extract-reports/hash) * [Water-Hash](https://www.cannabisreports.com/extract-reports/water-hash) * [Oil](https://www.cannabisreports.com/extract-reports/oil) * [Wax](https://www.cannabisreports.com/extract-reports/wax) * [Crumble](https://www.cannabisreports.com/extract-reports/crumble) * [Honeycomb](https://www.cannabisreports.com/extract-reports/honeycomb) * [Shatter](https://www.cannabisreports.com/extract-reports/shatter) * [Vaporizer-Disposable](https://www.cannabisreports.com/extract-reports/vaporizer-disposable) * [Vaporizer-Cartridge](https://www.cannabisreports.com/extract-reports/vaporizer-cartridge) [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"553524f6f3e2ce0d00190ff4","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts/3CV7E33XLHTJT2XZ4GMD00000 ","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"3CV7E33XLHTJT2XZ4GMD00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis extract you want information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Jesus OG - Shatter\",\n        \"ucpc\": \"3CV7E33XLHTJT2XZ4GMD00000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/3CV7E33XLHTJT2XZ4GMD00000\",\n        \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/hgh-extractions/tga-seeds/jesus-og/shatter.png\",\n        \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/hgh-extractions/tga-seeds/jesus-og/shatter.png\",\n        \"url\": \"https://www.cannabisreports.com/extract-reports/hgh-extractions/tga-seeds/jesus-og/shatter\",\n        \"image\": \"https://www.cannabisreports.com/images/extracts/shatter.jpg\",\n        \"producer\": {\n            \"name\": \"HGH Extractions\",\n            \"ucpc\": \"0000000000TJT2X0000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000TJT2X0000000000\"\n        },\n        \"type\": \"shatter\",\n        \"strain\": {\n            \"name\": \"Jesus OG\",\n            \"ucpc\": \"3CV7E33XLH000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/3CV7E33XLH000000000000000\"\n        },\n        \"labTest\": false,\n        \"thc\": false,\n        \"cbd\": false,\n        \"reviews\": 0,\n        \"createdAt\": {\n            \"datetime\": \"2015-04-22 22:43:07\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-04-22 22:43:08\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an extract with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/extracts/:ucpc"},"body":"","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-20T16:10:30.324Z","editedParams":true,"editedParams2":true,"excerpt":"Gets an individual extract based on the UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"extracts-ucpc","sync_unique":"","title":"/extracts/:ucpc","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts/:ucpc

Gets an individual extract based on the UCPC.

Path Params

ucpc:
required
string3CV7E33XLHTJT2XZ4GMD00000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis extract you want information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5535415549945b0d00cb4e33","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts/QLG39RN2AFPMR6WLTPLW00000/user","name":""}]},"params":[{"_id":"552fd625633a5b0d00e99e26","default":"QLG39RN2AFPMR6WLTPLW00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you want the user from.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"nickname\": \"Untamed Dame\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/users/untamed-dame\",\n        \"tagline\": \"Let's get weird.\",\n        \"url\": \"https://www.cannabisreports.com/user/profile/untamed-dame\",\n        \"slug\": \"untamed-dame\",\n        \"createdAt\": {\n            \"datetime\": \"2014-12-07 23:30:37\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-04-22 18:24:18\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an extract with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/extracts/:ucpc/user"},"body":"","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-20T18:11:33.321Z","editedParams":true,"editedParams2":true,"excerpt":"Get the user who added the extract to the database.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55232972e2de0a3500f0a2df","slug":"extracts-ucpc-user","sync_unique":"","title":"/extracts/:ucpc/user","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts/:ucpc/user

Get the user who added the extract to the database.

Path Params

ucpc:
required
stringQLG39RN2AFPMR6WLTPLW00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you want the user from.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5535418f3ad5c90d00d060d2","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts/9XVU762EQ4VU7TG3N9NM00000/reviews","name":""}]},"params":[{"_id":"552fd5a9f99ae00d00e054d2","default":"9XVU762EQ4VU7TG3N9NM00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you would like reviews for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/reviews/2e417f316a1f1101c8eb9ba6f63c9f994e9436ac\",\n            \"url\": \"https://www.cannabisreports.com/smoke-reports/2015/04/02/2e417f316a1f1101c8eb9ba6f63c9f994e9436ac/doc-chillington\",\n            \"euphoria\": \"6\",\n            \"creativity\": \"8\",\n            \"pain_relief\": null,\n            \"appetite_gain\": \"6\",\n            \"calming\": \"4\",\n            \"anxiety\": null,\n            \"spicy\": \"2\",\n            \"earthy\": \"6\",\n            \"fruity\": null,\n            \"sour\": null,\n            \"dry_mouth\": null,\n            \"createdAt\": {\n                \"datetime\": \"2015-04-02 23:58:25\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-04-02 23:58:25\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 1,\n            \"count\": 1,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an extract with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/extracts/:ucpc/reviews"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"Page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for more information.","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-20T18:12:31.121Z","editedParams":true,"editedParams2":true,"excerpt":"Get the reviews for a cannabis extract.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55232972e2de0a3500f0a2df","slug":"extracts-ucpc-reviews","sync_unique":"","title":"/extracts/:ucpc/reviews","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts/:ucpc/reviews

Get the reviews for a cannabis extract.

Path Params

ucpc:
required
string9XVU762EQ4VU7TG3N9NM00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you would like reviews for.
[block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information.
{"__v":0,"_id":"553541e6f07d6b0d0077be9e","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts/9XVU762EQ4VU7TG3N9NM00000/effectsFlavors","name":""}]},"params":[{"_id":"552fd68ef99ae00d00e054d7","default":"9XVU762EQ4VU7TG3N9NM00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you'd like the effects and flavors for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": {\n        \"euphoria\": \"6.0000\",\n        \"creativity\": \"8.0000\",\n        \"calming\": \"4.0000\",\n        \"numbness\": \"4.0000\",\n        \"appetite_gain\": \"6.0000\",\n        \"dry_mouth\": \"6.0000\",\n        \"fruity\": null,\n        \"spicy\": \"2.0000\",\n        \"earthy\": \"6.0000\",\n        \"sour\": null,\n        \"sweet\": null,\n        \"pine\": null,\n        \"anxiety\": null,\n        \"reviews\": 1\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find an extract with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/extracts/:ucpc/effectsFlavors"},"body":"","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-20T18:13:58.741Z","editedParams":true,"editedParams2":true,"excerpt":"Get the average effects and flavors from reviews for this extract.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55232972e2de0a3500f0a2df","slug":"extracts-ucpc-effectsflavors","sync_unique":"","title":"/extracts/:ucpc/effectsFlavors","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts/:ucpc/effectsFlavors

Get the average effects and flavors from reviews for this extract.

Path Params

ucpc:
required
string9XVU762EQ4VU7TG3N9NM00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you'd like the effects and flavors for.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"553536b71fd5700d00f863b0","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts/4PNYL2PNJ2TJT2X9PTTA00000/producer","name":""}]},"params":[{"_id":"553536b71fd5700d00f863b1","default":"4PNYL2PNJ2TJT2X9PTTA00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you want the [producer](doc:producer-object) for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"HGH Extractions\",\n        \"ucpc\": \"0000000000TJT2X0000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000TJT2X0000000000\",\n        \"qr\": \"https://www.cannabisreports.com/producer-reports/hgh-extractions/qr-code\",\n        \"url\": \"https://www.cannabisreports.com/producer-reports/hgh-extractions\",\n        \"image\": \"https://www.cannabisreports.com/images/profile/3/full_3726c52929c5e9424a0539c12ac215305b0d3cc2.jpg\",\n        \"reviews\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000TJT2X0000000000/reviews\"\n        },\n        \"extracts\": {\n            \"count\": 88,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000TJT2X0000000000/extracts\"\n        },\n        \"edibles\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000TJT2X0000000000/edibles\"\n        },\n        \"products\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000TJT2X0000000000/products\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2014-07-14 20:15:37\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2014-10-14 21:30:08\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an extract with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/extracts/:ucpc/producer"},"body":"Extracts in the Cannabis Reports system have a [producer](doc:producer-object) associated with them. Some [dispensaries](doc:dispensary-object) are not yet listing the company that produced their extracts for their menus. For those extracts, an \"Unknown Producer\" has been associated. Trying to get information about his producer will give you the [UCPC](doc:ucpc-universal-cannabis-product-code) and name with nothing more.\n\nMore information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-20T17:26:15.489Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the producer for a given extract.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55232972e2de0a3500f0a2df","slug":"extracts-ucpc-producer","sync_unique":"","title":"/extracts/:ucpc/producer","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts/:ucpc/producer

Gets the producer for a given extract.

Path Params

ucpc:
required
string4PNYL2PNJ2TJT2X9PTTA00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you want the [producer](doc:producer-object) for.
Extracts in the Cannabis Reports system have a [producer](doc:producer-object) associated with them. Some [dispensaries](doc:dispensary-object) are not yet listing the company that produced their extracts for their menus. For those extracts, an "Unknown Producer" has been associated. Trying to get information about his producer will give you the [UCPC](doc:ucpc-universal-cannabis-product-code) and name with nothing more. More information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Extracts in the Cannabis Reports system have a [producer](doc:producer-object) associated with them. Some [dispensaries](doc:dispensary-object) are not yet listing the company that produced their extracts for their menus. For those extracts, an "Unknown Producer" has been associated. Trying to get information about his producer will give you the [UCPC](doc:ucpc-universal-cannabis-product-code) and name with nothing more. More information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.
{"__v":0,"_id":"55353cf1f3e2ce0d0019103e","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts/QLG39RN2AFPMR6WLTPLW00000/strain","name":""}]},"params":[{"_id":"55353cf1f3e2ce0d0019103f","default":"QLG39RN2AFPMR6WLTPLW00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you want [strain](doc:strain-object) information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Blackwater OG\",\n        \"ucpc\": \"QLG39RN2AF000000000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/QLG39RN2AF000000000000000\",\n        \"qr\": \"https://www.cannabisreports.com/strain-reports/the-cali-connection/blackwater/qr-code.svg\",\n        \"url\": \"https://www.cannabisreports.com/strain-reports/the-cali-connection/blackwater\",\n        \"image\": \"https://www.cannabisreports.com/images/strains/d/full_d638b0d93eed0eca94c0894cf4e9dc7bdd2f860c.jpg\",\n        \"seedCompany\": {\n            \"name\": \"The Cali Connection\",\n            \"ucpc\": \"QLG3900000000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/QLG3900000000000000000000\"\n        },\n        \"genetics\": {\n            \"names\": \"Mendo Purps x San Fernando Valley OG (SFV OG)\",\n            \"ucpc\": \"9XVU7LXP9U000000000000000 x 9XVU7EYMZW000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/QLG39RN2AF000000000000000/genetics\"\n        },\n        \"lineage\": {\n            \"Afghanistan\": \"AF\"\n        },\n        \"children\": {\n            \"count\": 2,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/QLG39RN2AF000000000000000/children\"\n        },\n        \"reviews\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/QLG39RN2AF000000000000000/reviews\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2014-07-28 19:16:21\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2014-08-01 19:52:40\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an extract with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/extracts/:ucpc/strain"},"body":"","category":"55351c2af07d6b0d0077be48","createdAt":"2015-04-20T17:52:49.424Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the information about a strain for an extract with the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55232972e2de0a3500f0a2df","slug":"extracts-ucpc-strain","sync_unique":"","title":"/extracts/:ucpc/strain","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts/:ucpc/strain

Gets the information about a strain for an extract with the given UCPC.

Path Params

ucpc:
required
stringQLG39RN2AFPMR6WLTPLW00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the extract you want [strain](doc:strain-object) information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"554a7dbe6b448d0d00646b8c","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/extracts/9XVU7ZCENQVU7TGRFHPC00000/availability/geo/37.7749295/-122.4194155/25","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"CYGU94JYKYUY9V7TAFL200000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis extract you want availability for.","name":"ucpc","required":true,"type":"string","in":"path"},{"_id":"554a69e7156a480d00e2924f","required":true,"desc":"Latitude for the center of your availability search.","default":"37.7749295","type":"string","name":"lat","in":"path"},{"_id":"554a69e7156a480d00e2924e","required":true,"desc":"Longitude for the center of your availability search.","default":"-122.4194155","type":"string","name":"lng","in":"path"},{"_id":"554a69e7156a480d00e2924d","required":false,"desc":"Radius to search for in miles, max 25.","default":"10","type":"int","name":"radius","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Cherry Pie (Cherry Kush) - Vaporizer Cartridge\",\n            \"ucpc\": \"9XVU7ZCENQVU7TGRFHPC00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/9XVU7ZCENQVU7TGRFHPC00000\",\n            \"type\": \"extract\",\n            \"location\": {\n                \"name\": \"SFFOGG\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/sffogg\",\n                \"lat\": \"37.7717311\",\n                \"lng\": \"-122.4165409\"\n            },\n            \"price\": null,\n            \"price_half_gram\": \"0.00\",\n            \"price_gram\": \"40.00\",\n            \"price_eighth\": null,\n            \"price_quarter\": null,\n            \"price_half_ounce\": null,\n            \"price_ounce\": null,\n            \"createdAt\": {\n                \"datetime\": \"2014-05-20 21:29:37\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-05-21 04:53:05\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 16,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 2,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/extracts/9XVU7ZCENQVU7TGRFHPC00000/availability/geo/37.7749295/-122.4194155/25?page=2\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find an extract with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/extracts/:ucpc/availability/geo/:lat/:lng/:radius"},"body":"This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular extract.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for more information.","category":"55351c2af07d6b0d0077be48","createdAt":"2015-05-06T20:46:54.219Z","editedParams":true,"editedParams2":true,"excerpt":"Get information about the availability of an extract using latitude and longitude.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"55232972e2de0a3500f0a2df","slug":"extracts-ucpc-availability-geo-lat-lng-radius","sync_unique":"","title":"/extracts/:ucpc/availability/geo/:lat/:lng/:radius","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/extracts/:ucpc/availability/geo/:lat/:lng/:radius

Get information about the availability of an extract using latitude and longitude.

Path Params

ucpc:
required
stringCYGU94JYKYUY9V7TAFL200000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis extract you want availability for.
lat:
required
string37.7749295
Latitude for the center of your availability search.
lng:
required
string-122.4194155
Longitude for the center of your availability search.
radius:
integer10
Radius to search for in miles, max 25.
This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular extract. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular extract. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information.
{"__v":13,"_id":"5543ac8f12245b1900ba08dd","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis edibles cover a wide variety of consumable products that contain cannabis in various forms. From cotton candy, to tinctures, to dog treats, and everything in between. If it's a form of cannabis that is meant to be consumed, we categorize it as an edible.\n\nThe main forms of edibles that Cannabis Reports recognizes are:\n\n* [Baked Goods](https://www.cannabisreports.com/edible-reports/baked-good)\n* [Candy](https://www.cannabisreports.com/edible-reports/candy)\n* [Treat](https://www.cannabisreports.com/edible-reports/treat)\n* [Chocolate](https://www.cannabisreports.com/edible-reports/chocolate)\n* [Snack](https://www.cannabisreports.com/edible-reports/snack)\n* [Beverage](https://www.cannabisreports.com/edible-reports/beverage)\n* [Pill](https://www.cannabisreports.com/edible-reports/pill)\n* [Tincture](https://www.cannabisreports.com/edible-reports/tincture)\n\nWe also support \"[Other](https://www.cannabisreports.com/edible-reports/other)\" types of edibles. Some examples are:\n\n* Butter\n* Honey\n* Breath Strips\n* Tea\n* Ice Cream\n\n[Producers](doc:producer-object) measure the amount of cannabis in their edibles in a variety of ways. We recognize 4 ways for measuring the cannabis contents:\n\n* [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) mg\n* [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) mg\n* Cannabis mg\n* Hash Oil mg\n\nMore information about cannabis edibles can be found in our FAQ here:\n\nhttps://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-edible\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Name of the edible.\",\n    \"1-0\": \"ucpc\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) code for this edible.\",\n    \"2-0\": \"link\",\n    \"2-1\": \"`url`\",\n    \"2-2\": \"Link to the edible in the Cannabis Reports API.\",\n    \"3-0\": \"qr\",\n    \"3-1\": \"`url`\",\n    \"3-2\": \"Link to the QR code for this edible.\",\n    \"5-0\": \"url\",\n    \"5-1\": \"`url`\",\n    \"5-2\": \"Link to the edible listing on the Cannabis Reports website.\",\n    \"7-0\": \"producer\",\n    \"7-1\": \"`object`\",\n    \"7-2\": \"Information about the [producer](doc:producer-object) that created the edible.\",\n    \"8-0\": \"producer.name\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"Name of the [producer](doc:producer-object) of the edible.\",\n    \"9-0\": \"producer.ucpc\",\n    \"9-1\": \"`string`\",\n    \"9-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).\",\n    \"10-0\": \"producer.link\",\n    \"10-1\": \"`url`\",\n    \"10-2\": \"Link to the [producer](doc:producer-object) in the Cannabis Reports API.\",\n    \"22-0\": \"reviews.count\",\n    \"22-1\": \"`integer`\",\n    \"22-2\": \"Number of reviews for the edible.\",\n    \"24-0\": \"createdAt\",\n    \"24-1\": \"`object`\",\n    \"24-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the edible was added.\",\n    \"25-0\": \"updatedAt\",\n    \"25-1\": \"`object`\",\n    \"25-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the edible was updated.\",\n    \"12-0\": \"strain\",\n    \"12-1\": \"`object`\",\n    \"12-2\": \"[Strain](doc:strain-object) that was used in this edible.\",\n    \"13-0\": \"strain.name\",\n    \"13-1\": \"`string`\",\n    \"13-2\": \"Name of the [strain](doc:strain-object) used in this edible.\",\n    \"14-0\": \"strain.ucpc\",\n    \"14-1\": \"`string`\",\n    \"14-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used in this edible.\",\n    \"15-0\": \"strain.link\",\n    \"15-1\": \"`url`\",\n    \"15-2\": \"Link to the [strain](doc:strain-object) used in this edible in the Cannabis Reports API.\",\n    \"16-0\": \"labTest\",\n    \"16-1\": \"`url`\",\n    \"16-2\": \"Link to the PDF containing lab test information for this edible.\",\n    \"17-0\": \"thc\",\n    \"17-1\": \"`string`\",\n    \"17-2\": \"Milligrams of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this edible.\",\n    \"18-0\": \"cbd\",\n    \"18-1\": \"`string`\",\n    \"18-2\": \"Milligrams of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this edible.\",\n    \"6-0\": \"image\",\n    \"6-1\": \"`url`\",\n    \"6-2\": \"Link to the full size image for this edible.\",\n    \"4-0\": \"barcode\",\n    \"4-1\": \"`url`\",\n    \"4-2\": \"Link to the barcode for this edible.\",\n    \"19-0\": \"cannabis\",\n    \"19-1\": \"`string`\",\n    \"19-2\": \"Milligrams of cannabis in this edible.\",\n    \"20-0\": \"hashOil\",\n    \"20-1\": \"`string`\",\n    \"20-2\": \"Milligrams of hash oil in this edible.\",\n    \"11-0\": \"type\",\n    \"11-1\": \"`string`\",\n    \"11-2\": \"Type of cannabis edible.\",\n    \"23-0\": \"reviews.link\",\n    \"23-1\": \"`url`\",\n    \"23-2\": \"Link to the reviews for the edible.\",\n    \"21-0\": \"reviews\",\n    \"21-1\": \"`object`\",\n    \"21-2\": \"Object containing information on the reviews for the edible.\"\n  },\n  \"cols\": 3,\n  \"rows\": 26\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"Soda - Girl Scout Cookies and Cream\\\",\\n    \\\"ucpc\\\": \\\"4KXM32V9YFC3G2EUNWP400000\\\",\\n    \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000\\\",\\n    \\\"qr\\\": \\\"https://www.cannabisreports.com/edible-reports/qr-code/kushtown/soda-girl-scout-cookies-and-cream\\\",\\n    \\\"barcode\\\": \\\"https://www.cannabisreports.com/edible-reports/barcode/kushtown/soda-girl-scout-cookies-and-cream\\\",\\n    \\\"url\\\": \\\"https://www.cannabisreports.com/edible-reports/kushtown/soda-girl-scout-cookies-and-cream\\\",\\n    \\\"image\\\": \\\"https://www.cannabisreports.com/images/strains/no_image.png\\\",\\n    \\\"producer\\\": {\\n        \\\"name\\\": \\\"Kushtown\\\",\\n        \\\"ucpc\\\": \\\"0000000000C3G2E0000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000\\\"\\n    },\\n    \\\"type\\\": \\\"beverage\\\",\\n    \\\"strain\\\": {\\n        \\\"name\\\": \\\"Girl Scout Cookies\\\",\\n        \\\"ucpc\\\": \\\"4KXM32V9YF000000000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/4KXM32V9YF000000000000000\\\"\\n    },\\n    \\\"labTest\\\": false,\\n    \\\"thc\\\": \\\"78mg\\\",\\n    \\\"cbd\\\": false,\\n    \\\"cannabis\\\": false,\\n    \\\"hashOil\\\": false,\\n    \\\"reviews\\\": {\\n        \\\"count\\\": 0,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000/reviews\\\"\\n    },\\n    \\\"createdAt\\\": {\\n        \\\"datetime\\\": \\\"2015-04-20 08:13:34\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    },\\n    \\\"updatedAt\\\": {\\n        \\\"datetime\\\": \\\"2015-04-20 15:43:59\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Explore Edible Endpoints\"\n}\n[/block]\nHere are some of the results available from the different edible endpoints:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"[/edibles](doc:edibles)\",\n    \"0-1\": \"Gets a paginated list of edibles with optional sorting.\",\n    \"1-0\": \"[/edibles/type/:edibleType](doc:edibles-type-edibletype)\",\n    \"1-1\": \"Gets a paginated list of edibles for a given type with optional sorting.\",\n    \"2-0\": \"[/edibles/:ucpc](doc:edibles-ucpc)\",\n    \"2-1\": \"Gets an individual edible based on the UCPC.\",\n    \"3-0\": \"[/edibles/:ucpc/reviews](doc:edibles-ucpc-reviews)\",\n    \"3-1\": \"Get the reviews for a cannabis edible.\",\n    \"4-0\": \"[/edibles/:ucpc/effectsFlavors](doc:edibles-ucpc-effectsflavors)\",\n    \"4-1\": \"Get the average effects and flavors from reviews for this edible.\",\n    \"5-0\": \"[/edibles/:ucpc/producer](doc:edibles-ucpc-producer)\",\n    \"5-1\": \"Gets the producer for a given edible.\",\n    \"6-0\": \"[/edibles/:ucpc/strain](doc:edibles-ucpc-strain)\",\n    \"6-1\": \"Gets the information about a strain for an edible with the given UCPC.\",\n    \"7-0\": \"[/edibles/:ucpc/availability/geo/:lat/:lng/:radius](doc:edibles-ucpc-availability-geo-lat-lng-radius)\",\n    \"7-1\": \"Get information about the availability of an edible using latitude and longitude.\",\n    \"h-0\": \"Endpoint\",\n    \"h-1\": \"Result\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-05-01T16:40:47.241Z","excerpt":"Cannabis edibles in the Cannabis Reports system.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"edible-object","sync_unique":"","title":"Edible Object","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Edible Object

Cannabis edibles in the Cannabis Reports system.

Cannabis edibles cover a wide variety of consumable products that contain cannabis in various forms. From cotton candy, to tinctures, to dog treats, and everything in between. If it's a form of cannabis that is meant to be consumed, we categorize it as an edible. The main forms of edibles that Cannabis Reports recognizes are: * [Baked Goods](https://www.cannabisreports.com/edible-reports/baked-good) * [Candy](https://www.cannabisreports.com/edible-reports/candy) * [Treat](https://www.cannabisreports.com/edible-reports/treat) * [Chocolate](https://www.cannabisreports.com/edible-reports/chocolate) * [Snack](https://www.cannabisreports.com/edible-reports/snack) * [Beverage](https://www.cannabisreports.com/edible-reports/beverage) * [Pill](https://www.cannabisreports.com/edible-reports/pill) * [Tincture](https://www.cannabisreports.com/edible-reports/tincture) We also support "[Other](https://www.cannabisreports.com/edible-reports/other)" types of edibles. Some examples are: * Butter * Honey * Breath Strips * Tea * Ice Cream [Producers](doc:producer-object) measure the amount of cannabis in their edibles in a variety of ways. We recognize 4 ways for measuring the cannabis contents: * [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) mg * [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) mg * Cannabis mg * Hash Oil mg More information about cannabis edibles can be found in our FAQ here: https://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-edible [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the edible.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this edible.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the edible in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this edible.", "5-0": "url", "5-1": "`url`", "5-2": "Link to the edible listing on the Cannabis Reports website.", "7-0": "producer", "7-1": "`object`", "7-2": "Information about the [producer](doc:producer-object) that created the edible.", "8-0": "producer.name", "8-1": "`string`", "8-2": "Name of the [producer](doc:producer-object) of the edible.", "9-0": "producer.ucpc", "9-1": "`string`", "9-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).", "10-0": "producer.link", "10-1": "`url`", "10-2": "Link to the [producer](doc:producer-object) in the Cannabis Reports API.", "22-0": "reviews.count", "22-1": "`integer`", "22-2": "Number of reviews for the edible.", "24-0": "createdAt", "24-1": "`object`", "24-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the edible was added.", "25-0": "updatedAt", "25-1": "`object`", "25-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the edible was updated.", "12-0": "strain", "12-1": "`object`", "12-2": "[Strain](doc:strain-object) that was used in this edible.", "13-0": "strain.name", "13-1": "`string`", "13-2": "Name of the [strain](doc:strain-object) used in this edible.", "14-0": "strain.ucpc", "14-1": "`string`", "14-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used in this edible.", "15-0": "strain.link", "15-1": "`url`", "15-2": "Link to the [strain](doc:strain-object) used in this edible in the Cannabis Reports API.", "16-0": "labTest", "16-1": "`url`", "16-2": "Link to the PDF containing lab test information for this edible.", "17-0": "thc", "17-1": "`string`", "17-2": "Milligrams of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this edible.", "18-0": "cbd", "18-1": "`string`", "18-2": "Milligrams of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this edible.", "6-0": "image", "6-1": "`url`", "6-2": "Link to the full size image for this edible.", "4-0": "barcode", "4-1": "`url`", "4-2": "Link to the barcode for this edible.", "19-0": "cannabis", "19-1": "`string`", "19-2": "Milligrams of cannabis in this edible.", "20-0": "hashOil", "20-1": "`string`", "20-2": "Milligrams of hash oil in this edible.", "11-0": "type", "11-1": "`string`", "11-2": "Type of cannabis edible.", "23-0": "reviews.link", "23-1": "`url`", "23-2": "Link to the reviews for the edible.", "21-0": "reviews", "21-1": "`object`", "21-2": "Object containing information on the reviews for the edible." }, "cols": 3, "rows": 26 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Soda - Girl Scout Cookies and Cream\",\n \"ucpc\": \"4KXM32V9YFC3G2EUNWP400000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000\",\n \"qr\": \"https://www.cannabisreports.com/edible-reports/qr-code/kushtown/soda-girl-scout-cookies-and-cream\",\n \"barcode\": \"https://www.cannabisreports.com/edible-reports/barcode/kushtown/soda-girl-scout-cookies-and-cream\",\n \"url\": \"https://www.cannabisreports.com/edible-reports/kushtown/soda-girl-scout-cookies-and-cream\",\n \"image\": \"https://www.cannabisreports.com/images/strains/no_image.png\",\n \"producer\": {\n \"name\": \"Kushtown\",\n \"ucpc\": \"0000000000C3G2E0000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000\"\n },\n \"type\": \"beverage\",\n \"strain\": {\n \"name\": \"Girl Scout Cookies\",\n \"ucpc\": \"4KXM32V9YF000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4KXM32V9YF000000000000000\"\n },\n \"labTest\": false,\n \"thc\": \"78mg\",\n \"cbd\": false,\n \"cannabis\": false,\n \"hashOil\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2015-04-20 08:13:34\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-04-20 15:43:59\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Edible Endpoints" } [/block] Here are some of the results available from the different edible endpoints: [block:parameters] { "data": { "0-0": "[/edibles](doc:edibles)", "0-1": "Gets a paginated list of edibles with optional sorting.", "1-0": "[/edibles/type/:edibleType](doc:edibles-type-edibletype)", "1-1": "Gets a paginated list of edibles for a given type with optional sorting.", "2-0": "[/edibles/:ucpc](doc:edibles-ucpc)", "2-1": "Gets an individual edible based on the UCPC.", "3-0": "[/edibles/:ucpc/reviews](doc:edibles-ucpc-reviews)", "3-1": "Get the reviews for a cannabis edible.", "4-0": "[/edibles/:ucpc/effectsFlavors](doc:edibles-ucpc-effectsflavors)", "4-1": "Get the average effects and flavors from reviews for this edible.", "5-0": "[/edibles/:ucpc/producer](doc:edibles-ucpc-producer)", "5-1": "Gets the producer for a given edible.", "6-0": "[/edibles/:ucpc/strain](doc:edibles-ucpc-strain)", "6-1": "Gets the information about a strain for an edible with the given UCPC.", "7-0": "[/edibles/:ucpc/availability/geo/:lat/:lng/:radius](doc:edibles-ucpc-availability-geo-lat-lng-radius)", "7-1": "Get information about the availability of an edible using latitude and longitude.", "h-0": "Endpoint", "h-1": "Result" }, "cols": 2, "rows": 8 } [/block]
Cannabis edibles cover a wide variety of consumable products that contain cannabis in various forms. From cotton candy, to tinctures, to dog treats, and everything in between. If it's a form of cannabis that is meant to be consumed, we categorize it as an edible. The main forms of edibles that Cannabis Reports recognizes are: * [Baked Goods](https://www.cannabisreports.com/edible-reports/baked-good) * [Candy](https://www.cannabisreports.com/edible-reports/candy) * [Treat](https://www.cannabisreports.com/edible-reports/treat) * [Chocolate](https://www.cannabisreports.com/edible-reports/chocolate) * [Snack](https://www.cannabisreports.com/edible-reports/snack) * [Beverage](https://www.cannabisreports.com/edible-reports/beverage) * [Pill](https://www.cannabisreports.com/edible-reports/pill) * [Tincture](https://www.cannabisreports.com/edible-reports/tincture) We also support "[Other](https://www.cannabisreports.com/edible-reports/other)" types of edibles. Some examples are: * Butter * Honey * Breath Strips * Tea * Ice Cream [Producers](doc:producer-object) measure the amount of cannabis in their edibles in a variety of ways. We recognize 4 ways for measuring the cannabis contents: * [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) mg * [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) mg * Cannabis mg * Hash Oil mg More information about cannabis edibles can be found in our FAQ here: https://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-edible [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the edible.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this edible.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the edible in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this edible.", "5-0": "url", "5-1": "`url`", "5-2": "Link to the edible listing on the Cannabis Reports website.", "7-0": "producer", "7-1": "`object`", "7-2": "Information about the [producer](doc:producer-object) that created the edible.", "8-0": "producer.name", "8-1": "`string`", "8-2": "Name of the [producer](doc:producer-object) of the edible.", "9-0": "producer.ucpc", "9-1": "`string`", "9-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).", "10-0": "producer.link", "10-1": "`url`", "10-2": "Link to the [producer](doc:producer-object) in the Cannabis Reports API.", "22-0": "reviews.count", "22-1": "`integer`", "22-2": "Number of reviews for the edible.", "24-0": "createdAt", "24-1": "`object`", "24-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the edible was added.", "25-0": "updatedAt", "25-1": "`object`", "25-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the edible was updated.", "12-0": "strain", "12-1": "`object`", "12-2": "[Strain](doc:strain-object) that was used in this edible.", "13-0": "strain.name", "13-1": "`string`", "13-2": "Name of the [strain](doc:strain-object) used in this edible.", "14-0": "strain.ucpc", "14-1": "`string`", "14-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used in this edible.", "15-0": "strain.link", "15-1": "`url`", "15-2": "Link to the [strain](doc:strain-object) used in this edible in the Cannabis Reports API.", "16-0": "labTest", "16-1": "`url`", "16-2": "Link to the PDF containing lab test information for this edible.", "17-0": "thc", "17-1": "`string`", "17-2": "Milligrams of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this edible.", "18-0": "cbd", "18-1": "`string`", "18-2": "Milligrams of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this edible.", "6-0": "image", "6-1": "`url`", "6-2": "Link to the full size image for this edible.", "4-0": "barcode", "4-1": "`url`", "4-2": "Link to the barcode for this edible.", "19-0": "cannabis", "19-1": "`string`", "19-2": "Milligrams of cannabis in this edible.", "20-0": "hashOil", "20-1": "`string`", "20-2": "Milligrams of hash oil in this edible.", "11-0": "type", "11-1": "`string`", "11-2": "Type of cannabis edible.", "23-0": "reviews.link", "23-1": "`url`", "23-2": "Link to the reviews for the edible.", "21-0": "reviews", "21-1": "`object`", "21-2": "Object containing information on the reviews for the edible." }, "cols": 3, "rows": 26 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Soda - Girl Scout Cookies and Cream\",\n \"ucpc\": \"4KXM32V9YFC3G2EUNWP400000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000\",\n \"qr\": \"https://www.cannabisreports.com/edible-reports/qr-code/kushtown/soda-girl-scout-cookies-and-cream\",\n \"barcode\": \"https://www.cannabisreports.com/edible-reports/barcode/kushtown/soda-girl-scout-cookies-and-cream\",\n \"url\": \"https://www.cannabisreports.com/edible-reports/kushtown/soda-girl-scout-cookies-and-cream\",\n \"image\": \"https://www.cannabisreports.com/images/strains/no_image.png\",\n \"producer\": {\n \"name\": \"Kushtown\",\n \"ucpc\": \"0000000000C3G2E0000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000\"\n },\n \"type\": \"beverage\",\n \"strain\": {\n \"name\": \"Girl Scout Cookies\",\n \"ucpc\": \"4KXM32V9YF000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4KXM32V9YF000000000000000\"\n },\n \"labTest\": false,\n \"thc\": \"78mg\",\n \"cbd\": false,\n \"cannabis\": false,\n \"hashOil\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2015-04-20 08:13:34\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-04-20 15:43:59\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Edible Endpoints" } [/block] Here are some of the results available from the different edible endpoints: [block:parameters] { "data": { "0-0": "[/edibles](doc:edibles)", "0-1": "Gets a paginated list of edibles with optional sorting.", "1-0": "[/edibles/type/:edibleType](doc:edibles-type-edibletype)", "1-1": "Gets a paginated list of edibles for a given type with optional sorting.", "2-0": "[/edibles/:ucpc](doc:edibles-ucpc)", "2-1": "Gets an individual edible based on the UCPC.", "3-0": "[/edibles/:ucpc/reviews](doc:edibles-ucpc-reviews)", "3-1": "Get the reviews for a cannabis edible.", "4-0": "[/edibles/:ucpc/effectsFlavors](doc:edibles-ucpc-effectsflavors)", "4-1": "Get the average effects and flavors from reviews for this edible.", "5-0": "[/edibles/:ucpc/producer](doc:edibles-ucpc-producer)", "5-1": "Gets the producer for a given edible.", "6-0": "[/edibles/:ucpc/strain](doc:edibles-ucpc-strain)", "6-1": "Gets the information about a strain for an edible with the given UCPC.", "7-0": "[/edibles/:ucpc/availability/geo/:lat/:lng/:radius](doc:edibles-ucpc-availability-geo-lat-lng-radius)", "7-1": "Get information about the availability of an edible using latitude and longitude.", "h-0": "Endpoint", "h-1": "Result" }, "cols": 2, "rows": 8 } [/block]
{"__v":0,"_id":"553925768d56860d00c1ce6b","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles?sort=-updatedAt&page=3"}]},"params":[{"_id":"552c3ee10b701a1700470d86","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"552c3fc1d9f89e0d0015a5b3","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Marshmellow Crispy\",\n            \"ucpc\": \"00000000006769LXCE2X00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/00000000006769LXCE2X00000\",\n            \"qr\": \"https://www.cannabisreports.com/edible-reports/qr-code/the-baykery/marshmellow-crispy\",\n            \"barcode\": \"https://www.cannabisreports.com/edible-reports/barcode/the-baykery/marshmellow-crispy\",\n            \"url\": \"https://www.cannabisreports.com/edible-reports/the-baykery/marshmellow-crispy\",\n            \"image\": \"https://www.cannabisreports.com/images/edibles/5/full_541082d069457b57e90d203d0d015c26ee2be071.jpg\",\n            \"producer\": {\n                \"name\": \"The Baykery\",\n                \"ucpc\": \"00000000006769L0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/00000000006769L0000000000\"\n            },\n            \"type\": \"treat\",\n            \"strain\": [],\n            \"labTest\": false,\n            \"thc\": \"120mg\",\n            \"cbd\": false,\n            \"cannabis\": false,\n            \"hashOil\": false,\n            \"reviews\": 0,\n            \"createdAt\": {\n                \"datetime\": \"2014-09-29 17:52:50\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-05-05 00:56:27\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 3068,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 307,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/edibles?sort=-updatedAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/edibles?sort=-updatedAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/edibles"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `edibles` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-04-23T17:01:42.256Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of edibles with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"edibles","sync_unique":"","title":"/edibles","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles

Gets a paginated list of edibles with optional sorting.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `edibles` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `edibles` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"55392ae58d56860d00c1ce74","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles/type/chocolate?sort=-updatedAt&page=3"}]},"params":[{"_id":"5536cabe8bb21f0d006f5d37","default":"chocolate","desc":"The type of edible you want to search through.","name":"edibleType","required":true,"type":"string","in":"path"},{"_id":"552c3ee10b701a1700470d86","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"552c3fc1d9f89e0d0015a5b3","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Terra Blueberry Bites\",\n            \"ucpc\": \"0000000000L6M7ENLJVX00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/0000000000L6M7ENLJVX00000\",\n            \"qr\": \"https://www.cannabisreports.com/edible-reports/qr-code/kiva/terra-blueberry-bites\",\n            \"barcode\": \"https://www.cannabisreports.com/edible-reports/barcode/kiva/terra-blueberry-bites\",\n            \"url\": \"https://www.cannabisreports.com/edible-reports/kiva/terra-blueberry-bites\",\n            \"image\": \"https://www.cannabisreports.com/images/edibles/f/full_f29d34f36f40c96e26419caad6a668618bd417bb.jpg\",\n            \"producer\": {\n                \"name\": \"Kiva\",\n                \"ucpc\": \"0000000000L6M7E0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000\"\n            },\n            \"type\": \"chocolate\",\n            \"strain\": [],\n            \"labTest\": false,\n            \"thc\": \"120mg\",\n            \"cbd\": false,\n            \"cannabis\": false,\n            \"hashOil\": false,\n            \"reviews\": 2,\n            \"createdAt\": {\n                \"datetime\": \"2015-03-12 21:02:48\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-03-12 21:02:48\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 354,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 36,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/edibles/type/chocolate?sort=-updatedAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/edibles/type/chocolate?sort=-updatedAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/edibles/type/:edibleType"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"edibleType\"\n}\n[/block]\nOne of the various types of edibles you would like to filter by. See the [`Cannabis Edibles`](doc:edible-object) object definition for valid types.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `edibles` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for more information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-04-23T17:24:53.479Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of edibles for a given type with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"edibles-type-edibletype","sync_unique":"","title":"/edibles/type/:edibleType","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles/type/:edibleType

Gets a paginated list of edibles for a given type with optional sorting.

Path Params

edibleType:
required
stringchocolate
The type of edible you want to search through.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "edibleType" } [/block] One of the various types of edibles you would like to filter by. See the [`Cannabis Edibles`](doc:edible-object) object definition for valid types. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `edibles` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "edibleType" } [/block] One of the various types of edibles you would like to filter by. See the [`Cannabis Edibles`](doc:edible-object) object definition for valid types. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `edibles` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for more information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"55392b8227f8540d0024f08b","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000 ","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"4KXM32V9YFC3G2EUNWP400000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis edible you want information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Soda - Girl Scout Cookies and Cream\",\n        \"ucpc\": \"4KXM32V9YFC3G2EUNWP400000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000\",\n        \"qr\": \"https://www.cannabisreports.com/edible-reports/qr-code/kushtown/soda-girl-scout-cookies-and-cream\",\n        \"barcode\": \"https://www.cannabisreports.com/edible-reports/barcode/kushtown/soda-girl-scout-cookies-and-cream\",\n        \"url\": \"https://www.cannabisreports.com/edible-reports/kushtown/soda-girl-scout-cookies-and-cream\",\n        \"image\": \"https://www.cannabisreports.com/images/strains/no_image.png\",\n        \"producer\": {\n            \"name\": \"Kushtown\",\n            \"ucpc\": \"0000000000C3G2E0000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000\"\n        },\n        \"type\": \"beverage\",\n        \"strain\": {\n            \"name\": \"Girl Scout Cookies\",\n            \"ucpc\": \"4KXM32V9YF000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4KXM32V9YF000000000000000\"\n        },\n        \"labTest\": false,\n        \"thc\": \"78mg\",\n        \"cbd\": false,\n        \"cannabis\": false,\n        \"hashOil\": false,\n        \"reviews\": 0,\n        \"createdAt\": {\n            \"datetime\": \"2015-04-20 08:13:34\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-04-20 15:43:59\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an edible with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/edibles/:ucpc"},"body":"","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-04-23T17:27:30.545Z","editedParams":true,"editedParams2":true,"excerpt":"Gets an individual edible based on the UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"edibles-ucpc","sync_unique":"","title":"/edibles/:ucpc","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles/:ucpc

Gets an individual edible based on the UCPC.

Path Params

ucpc:
required
string4KXM32V9YFC3G2EUNWP400000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis edible you want information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"55392d34878c511900e0b92c","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000/user","name":""}]},"params":[{"_id":"552fd625633a5b0d00e99e26","default":"4KXM32V9YFC3G2EUNWP400000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you want the user from.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"nickname\": \"Untamed Dame\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/users/untamed-dame\",\n        \"tagline\": \"Let's get weird.\",\n        \"url\": \"https://www.cannabisreports.com/user/profile/untamed-dame\",\n        \"slug\": \"untamed-dame\",\n        \"createdAt\": {\n            \"datetime\": \"2014-12-07 23:30:37\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-04-22 18:24:18\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an edible with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/edibles/:ucpc/user"},"body":"","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-04-23T17:34:44.591Z","editedParams":true,"editedParams2":true,"excerpt":"Get the user who added the edible to the database.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55232972e2de0a3500f0a2df","slug":"edibles-ucpc-user","sync_unique":"","title":"/edibles/:ucpc/user","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles/:ucpc/user

Get the user who added the edible to the database.

Path Params

ucpc:
required
string4KXM32V9YFC3G2EUNWP400000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you want the user from.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5539301e27f8540d0024f08f","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles/0000000000L6M7ENLJVX00000/reviews","name":""}]},"params":[{"_id":"552fd5a9f99ae00d00e054d2","default":"0000000000L6M7ENLJVX00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you would like reviews for.","name":"ucpc","required":false,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/reviews/be1a9af83cd9766c4635d4aa3d21eb8c6ae787ed\",\n            \"url\": \"https://www.cannabisreports.com/smoke-reports/2015/04/07/be1a9af83cd9766c4635d4aa3d21eb8c6ae787ed/david\",\n            \"euphoria\": \"6\",\n            \"creativity\": \"8\",\n            \"pain_relief\": null,\n            \"appetite_gain\": \"10\",\n            \"calming\": \"6\",\n            \"anxiety\": null,\n            \"spicy\": \"4\",\n            \"earthy\": \"4\",\n            \"fruity\": \"8\",\n            \"sour\": null,\n            \"dry_mouth\": null,\n            \"createdAt\": {\n                \"datetime\": \"2015-04-07 00:20:31\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-04-07 00:20:31\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 2,\n            \"count\": 2,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n}      ","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a product with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/edibles/:ucpc/reviews"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"Page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-04-23T17:47:10.157Z","editedParams":true,"editedParams2":true,"excerpt":"Get the reviews for a cannabis edible.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55232972e2de0a3500f0a2df","slug":"edibles-ucpc-reviews","sync_unique":"","title":"/edibles/:ucpc/reviews","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles/:ucpc/reviews

Get the reviews for a cannabis edible.

Path Params

ucpc:
string0000000000L6M7ENLJVX00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you would like reviews for.
[block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":0,"_id":"553932c4fd56310d00b1748f","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles/0000000000L6M7ENLJVX00000/effectsFlavors","name":""}]},"params":[{"_id":"552fd68ef99ae00d00e054d7","default":"0000000000L6M7ENLJVX00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you'd like the effects and flavors for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": {\n        \"euphoria\": \"6.0000\",\n        \"creativity\": \"8.0000\",\n        \"calming\": \"6.0000\",\n        \"numbness\": \"8.0000\",\n        \"appetite_gain\": \"10.0000\",\n        \"dry_mouth\": \"4.5000\",\n        \"fruity\": \"9.0000\",\n        \"spicy\": \"4.0000\",\n        \"earthy\": \"4.0000\",\n        \"sour\": null,\n        \"sweet\": \"9.0000\",\n        \"pine\": null,\n        \"anxiety\": null,\n        \"reviews\": 2\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a product with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/edibles/:ucpc/effectsFlavors"},"body":"","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-04-23T17:58:28.163Z","editedParams":true,"editedParams2":true,"excerpt":"Get the average effects and flavors from reviews for this edible.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55232972e2de0a3500f0a2df","slug":"edibles-ucpc-effectsflavors","sync_unique":"","title":"/edibles/:ucpc/effectsFlavors","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles/:ucpc/effectsFlavors

Get the average effects and flavors from reviews for this edible.

Path Params

ucpc:
required
string0000000000L6M7ENLJVX00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you'd like the effects and flavors for.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"55392dec545cd90d0011e608","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000/producer","name":""}]},"params":[{"_id":"553536b71fd5700d00f863b1","default":"4KXM32V9YFC3G2EUNWP400000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you want the [producer](doc:producer-object) for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Kushtown\",\n        \"ucpc\": \"0000000000C3G2E0000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000\",\n        \"qr\": \"https://www.cannabisreports.com/producer-reports/kushtown/qr-code\",\n        \"url\": \"https://www.cannabisreports.com/producer-reports/kushtown\",\n        \"image\": \"https://www.cannabisreports.com/images/profile/c/full_c2c46561e1edec61ea0ffdea01c94509abd5c010.jpg\",\n        \"reviews\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000/reviews\"\n        },\n        \"extracts\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000/extracts\"\n        },\n        \"edibles\": {\n            \"count\": 44,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000/edibles\"\n        },\n        \"products\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000C3G2E0000000000/products\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2014-11-07 03:39:09\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2014-11-07 04:13:54\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an edible with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/edibles/:ucpc/producer"},"body":"More information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-04-23T17:37:48.347Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the producer for a given edible.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55232972e2de0a3500f0a2df","slug":"edibles-ucpc-producer","sync_unique":"","title":"/edibles/:ucpc/producer","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles/:ucpc/producer

Gets the producer for a given edible.

Path Params

ucpc:
required
string4KXM32V9YFC3G2EUNWP400000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you want the [producer](doc:producer-object) for.
More information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



More information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.
{"__v":0,"_id":"553933a0f426ca0d003ae48d","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles/4KXM32V9YFC3G2EUNWP400000/strain","name":""}]},"params":[{"_id":"55353cf1f3e2ce0d0019103f","default":"4KXM32V9YFC3G2EUNWP400000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you want [strain](doc:strain-object) information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Girl Scout Cookies\",\n        \"ucpc\": \"4KXM32V9YF000000000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4KXM32V9YF000000000000000\",\n        \"qr\": \"https://www.cannabisreports.com/strain-reports/cookie-family/girl-scout-cookies/qr-code.svg\",\n        \"url\": \"https://www.cannabisreports.com/strain-reports/cookie-family/girl-scout-cookies\",\n        \"image\": \"https://www.cannabisreports.com/images/strains/b/full_bb267b218903ded6aff0d4cf1ec6e911e22017e3.jpg\",\n        \"seedCompany\": {\n            \"name\": \"Cookie Family\",\n            \"ucpc\": \"4KXM300000000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/4KXM300000000000000000000\"\n        },\n        \"genetics\": {\n            \"names\": \"F1 / Durban Poison / OG Kush (Ogreskush)\",\n            \"ucpc\": \"4KXM33PGZW000000000000000 / 9XVU7GD2AP000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4KXM32V9YF000000000000000/genetics\"\n        },\n        \"lineage\": {\n            \"Afghanistan\": \"AF\",\n            \"South Africa\": \"ZA\"\n        },\n        \"children\": {\n            \"count\": 66,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4KXM32V9YF000000000000000/children\"\n        },\n        \"reviews\": {\n            \"count\": 2,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/4KXM32V9YF000000000000000/reviews\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2014-05-16 16:42:38\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2014-06-07 08:06:32\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an edible with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/edibles/:ucpc/strain"},"body":"","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-04-23T18:02:08.112Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the information about a strain for an edible with the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55232972e2de0a3500f0a2df","slug":"edibles-ucpc-strain","sync_unique":"","title":"/edibles/:ucpc/strain","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles/:ucpc/strain

Gets the information about a strain for an edible with the given UCPC.

Path Params

ucpc:
required
string4KXM32V9YFC3G2EUNWP400000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the edible you want [strain](doc:strain-object) information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"554a7e5b6b448d0d00646b90","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/edibles/0000000000L6M7ECZEXH00000/availability/geo/37.7749295/-122.4194155/25","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"0000000000L6M7ECZEXH00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis edible you want availability for.","name":"ucpc","required":true,"type":"string","in":"path"},{"_id":"554a69e7156a480d00e2924f","required":true,"desc":"Latitude for the center of your availability search.","default":"37.7749295","type":"string","name":"lat","in":"path"},{"_id":"554a69e7156a480d00e2924e","required":true,"desc":"Longitude for the center of your availability search.","default":"-122.4194155","type":"string","name":"lng","in":"path"},{"_id":"554a69e7156a480d00e2924d","required":false,"desc":"Radius to search for in miles, max 25.","default":"10","type":"int","name":"radius","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Chocolate Bar (180MG) - Vanilla Chai Milk Chocolate\",\n            \"ucpc\": \"0000000000L6M7ECZEXH00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/0000000000L6M7ECZEXH00000\",\n            \"type\": \"edible\",\n            \"location\": {\n                \"name\": \"SFFOGG\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/sffogg\",\n                \"lat\": \"37.7717311\",\n                \"lng\": \"-122.4165409\"\n            },\n            \"price\": \"20.00\",\n            \"price_half_gram\": null,\n            \"price_gram\": null,\n            \"price_eighth\": null,\n            \"price_quarter\": null,\n            \"price_half_ounce\": null,\n            \"price_ounce\": null,\n            \"createdAt\": {\n                \"datetime\": \"2014-05-20 21:29:37\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-05-21 04:53:05\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        { ... }\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 35,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 4,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/edibles/0000000000L6M7ECZEXH00000/availability/geo/37.7749295/-122.4194155/25?page=2\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find an edible with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/edibles/:ucpc/availability/geo/:lat/:lng/:radius"},"body":"This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular edible.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"55391fbc8d56860d00c1ce5e","createdAt":"2015-05-06T20:49:31.706Z","editedParams":true,"editedParams2":true,"excerpt":"Get information about the availability of an edible using latitude and longitude.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"55232972e2de0a3500f0a2df","slug":"edibles-ucpc-availability-geo-lat-lng-radius","sync_unique":"","title":"/edibles/:ucpc/availability/geo/:lat/:lng/:radius","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/edibles/:ucpc/availability/geo/:lat/:lng/:radius

Get information about the availability of an edible using latitude and longitude.

Path Params

ucpc:
required
string0000000000L6M7ECZEXH00000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis edible you want availability for.
lat:
required
string37.7749295
Latitude for the center of your availability search.
lng:
required
string-122.4194155
Longitude for the center of your availability search.
radius:
integer10
Radius to search for in miles, max 25.
This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular edible. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular edible. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":11,"_id":"5543acf662b30e0d004b1763","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis products cover a wide variety of additional products that contain cannabis. Anything that wouldn't be consumed like an [edible](doc:edible-object) or [extract](doc:extract-object) falls into this category. We also have pre-rolled cannabis in this category.\n\nThe main forms of products that Cannabis Reports recognizes are:\n\n* [Bath](https://www.cannabisreports.com/product-reports/bath)\n* [Topical](https://www.cannabisreports.com/product-reports/topical)\n* [Skin Care](https://www.cannabisreports.com/product-reports/skin-care)\n* [Pre-Roll](https://www.cannabisreports.com/product-reports/pre-roll)\n\nWe also support \"[Other](https://www.cannabisreports.com/product-reports/other)\" types of products. Some examples are:\n\n* Lip Balm\n* Massage Oil\n* Personal Lubricant\n\nProducers measure the amount of cannabis in their products in a variety of ways. We recognize 4 ways for measuring the cannabis contents:\n\n* [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) mg\n* [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) mg\n* Cannabis mg\n* Hash Oil mg\n\nMore information about cannabis products can be found in our FAQ here:\n\nhttps://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-product\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Name of the product.\",\n    \"1-0\": \"ucpc\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) code for this product.\",\n    \"2-0\": \"link\",\n    \"2-1\": \"`url`\",\n    \"2-2\": \"Link to the product in the Cannabis Reports API.\",\n    \"3-0\": \"qr\",\n    \"3-1\": \"`url`\",\n    \"3-2\": \"Link to the QR code for this product.\",\n    \"5-0\": \"url\",\n    \"5-1\": \"`url`\",\n    \"5-2\": \"Link to the product listing on the Cannabis Reports website.\",\n    \"7-0\": \"producer\",\n    \"7-1\": \"`object`\",\n    \"7-2\": \"Information about the [producer](doc:producer-object) that created the product.\",\n    \"8-0\": \"producer.name\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"Name of the [producer](doc:producer-object) of the product.\",\n    \"9-0\": \"producer.ucpc\",\n    \"9-1\": \"`string`\",\n    \"9-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).\",\n    \"10-0\": \"producer.link\",\n    \"10-1\": \"`url`\",\n    \"10-2\": \"Link to the [producer](doc:producer-object) in the Cannabis Reports API.\",\n    \"22-0\": \"reviews.count\",\n    \"22-1\": \"`integer`\",\n    \"22-2\": \"Number of reviews for the product.\",\n    \"24-0\": \"createdAt\",\n    \"24-1\": \"`object`\",\n    \"24-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the product was added.\",\n    \"25-0\": \"updatedAt\",\n    \"25-1\": \"`object`\",\n    \"25-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the product was updated.\",\n    \"12-0\": \"strain\",\n    \"12-1\": \"`object`\",\n    \"12-2\": \"[Strain](doc:strain-object) that was used in this product.\",\n    \"13-0\": \"strain.name\",\n    \"13-1\": \"`string`\",\n    \"13-2\": \"Name of the [strain](doc:strain-object) used in this product.\",\n    \"14-0\": \"strain.ucpc\",\n    \"14-1\": \"`string`\",\n    \"14-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used in this product.\",\n    \"15-0\": \"strain.link\",\n    \"15-1\": \"`url`\",\n    \"15-2\": \"Link to the [strain](doc:strain-object) used in this product in the Cannabis Reports API.\",\n    \"16-0\": \"labTest\",\n    \"16-1\": \"`url`\",\n    \"16-2\": \"Link to the PDF containing lab test information for this product.\",\n    \"17-0\": \"thc\",\n    \"17-1\": \"`string`\",\n    \"17-2\": \"Milligrams of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this product.\",\n    \"18-0\": \"cbd\",\n    \"18-1\": \"`string`\",\n    \"18-2\": \"Milligrams of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this product.\",\n    \"6-0\": \"image\",\n    \"6-1\": \"`url`\",\n    \"6-2\": \"Link to the full size image for this product.\",\n    \"4-0\": \"barcode\",\n    \"4-1\": \"`url`\",\n    \"4-2\": \"Link to the barcode for this product.\",\n    \"19-0\": \"cannabis\",\n    \"19-1\": \"`string`\",\n    \"19-2\": \"Milligrams of cannabis in this product.\",\n    \"20-0\": \"hashOil\",\n    \"20-1\": \"`string`\",\n    \"20-2\": \"Milligrams of hash oil in this product.\",\n    \"11-0\": \"type\",\n    \"11-2\": \"Type of cannabis product.\",\n    \"11-1\": \"`string`\",\n    \"21-0\": \"reviews\",\n    \"21-1\": \"`object`\",\n    \"21-2\": \"Object containing information on the reviews for the product.\",\n    \"23-0\": \"reviews.link\",\n    \"23-1\": \"`url`\",\n    \"23-2\": \"Link to the reviews for the product.\"\n  },\n  \"cols\": 3,\n  \"rows\": 26\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n        \\\"name\\\": \\\"Absorb CBD\\\",\\n        \\\"ucpc\\\": \\\"9XVU7XPL4JQQLU2M9A9G00000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/products/9XVU7XPL4JQQLU2M9A9G00000\\\",\\n        \\\"qr\\\": \\\"https://www.cannabisreports.com/product-reports/qr-code/absorb-cbd/absorb-cbd.png\\\",\\n        \\\"barcode\\\": \\\"https://www.cannabisreports.com/product-reports/barcode/absorb-cbd/absorb-cbd.png\\\",\\n        \\\"url\\\": \\\"https://www.cannabisreports.com/product-reports/absorb-cbd/absorb-cbd\\\",\\n        \\\"image\\\": \\\"https://www.cannabisreports.com/images/products/c/full_cb900a5edb9cce37ce721a4460bd3b22a8434d76.jpg\\\",\\n        \\\"producer\\\": {\\n            \\\"name\\\": \\\"Absorb CBD\\\",\\n            \\\"ucpc\\\": \\\"0000000000QQLU20000000000\\\",\\n            \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000QQLU20000000000\\\"\\n        },\\n        \\\"type\\\": \\\"topical\\\",\\n        \\\"strain\\\": {\\n            \\\"name\\\": \\\"ACDC (AC/DC)\\\",\\n            \\\"ucpc\\\": \\\"9XVU7XPL4J000000000000000\\\",\\n            \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/9XVU7XPL4J000000000000000\\\"\\n        },\\n        \\\"labTest\\\": \\\"https://www.cannabisreports.com/lab-tests/f/f08f252c9a66869a232a6f97e0af91c0d602293b.pdf\\\",\\n        \\\"thc\\\": \\\"8mg\\\",\\n        \\\"cbd\\\": \\\"200mg\\\",\\n        \\\"cannabis\\\": false,\\n        \\\"hashOil\\\": false,\\n        \\\"reviews\\\": {\\n            \\\"count\\\": 0,\\n            \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/products/9XVU7XPL4JQQLU2M9A9G00000/reviews\\\"\\n        },\\n        \\\"createdAt\\\": {\\n            \\\"datetime\\\": \\\"2015-04-22 18:43:10\\\",\\n            \\\"timezone\\\": \\\"UTC\\\"\\n        },\\n        \\\"updatedAt\\\": {\\n            \\\"datetime\\\": \\\"2015-05-15 18:33:46\\\",\\n            \\\"timezone\\\": \\\"UTC\\\"\\n        }\\n    }\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Explore Product Endpoints\"\n}\n[/block]\nHere are some of the results available from the different product endpoints:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"[/products](doc:products)\",\n    \"0-1\": \"Gets a paginated list of products with optional sorting.\",\n    \"1-0\": \"[/products/type/:productType](doc:products-type-producttype)\",\n    \"1-1\": \"Gets a paginated list of products for a given type with optional sorting.\",\n    \"2-1\": \"Gets an individual product based on the UCPC.\",\n    \"2-0\": \"[/products/:ucpc](doc:products-ucpc)\",\n    \"3-0\": \"[/products/:ucpc/reviews](doc:products-ucpc-reviews)\",\n    \"3-1\": \"Gets the reviews for a cannabis product.\",\n    \"4-0\": \"[/products/:ucpc/effectsFlavors](doc:products-ucpc-effectsflavors)\",\n    \"4-1\": \"Gets the average effects and flavors from reviews for this product.\",\n    \"5-0\": \"[/products/:ucpc/producer](doc:products-ucpc-producer)\",\n    \"5-1\": \"Gets the producer for a given product.\",\n    \"6-0\": \"[/products/:ucpc/strain](doc:products-ucpc-strain)\",\n    \"6-1\": \"Gets the information about a strain for a product with the given UCPC.\",\n    \"7-0\": \"[/products/:ucpc/availability/geo/:lat/:lng/:radius](doc:products-ucpc-availability-geo-lat-lng-radius)\",\n    \"7-1\": \"Get information about the availability of a product using latitude and longitude.\",\n    \"h-0\": \"Endpoint\",\n    \"h-1\": \"Result\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","category":"553990bb69c2630d00a85545","createdAt":"2015-05-01T16:42:30.545Z","excerpt":"Cannabis products in the Cannabis Reports system.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"product-object","sync_unique":"","title":"Product Object","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Product Object

Cannabis products in the Cannabis Reports system.

Cannabis products cover a wide variety of additional products that contain cannabis. Anything that wouldn't be consumed like an [edible](doc:edible-object) or [extract](doc:extract-object) falls into this category. We also have pre-rolled cannabis in this category. The main forms of products that Cannabis Reports recognizes are: * [Bath](https://www.cannabisreports.com/product-reports/bath) * [Topical](https://www.cannabisreports.com/product-reports/topical) * [Skin Care](https://www.cannabisreports.com/product-reports/skin-care) * [Pre-Roll](https://www.cannabisreports.com/product-reports/pre-roll) We also support "[Other](https://www.cannabisreports.com/product-reports/other)" types of products. Some examples are: * Lip Balm * Massage Oil * Personal Lubricant Producers measure the amount of cannabis in their products in a variety of ways. We recognize 4 ways for measuring the cannabis contents: * [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) mg * [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) mg * Cannabis mg * Hash Oil mg More information about cannabis products can be found in our FAQ here: https://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-product [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the product.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this product.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the product in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this product.", "5-0": "url", "5-1": "`url`", "5-2": "Link to the product listing on the Cannabis Reports website.", "7-0": "producer", "7-1": "`object`", "7-2": "Information about the [producer](doc:producer-object) that created the product.", "8-0": "producer.name", "8-1": "`string`", "8-2": "Name of the [producer](doc:producer-object) of the product.", "9-0": "producer.ucpc", "9-1": "`string`", "9-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).", "10-0": "producer.link", "10-1": "`url`", "10-2": "Link to the [producer](doc:producer-object) in the Cannabis Reports API.", "22-0": "reviews.count", "22-1": "`integer`", "22-2": "Number of reviews for the product.", "24-0": "createdAt", "24-1": "`object`", "24-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the product was added.", "25-0": "updatedAt", "25-1": "`object`", "25-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the product was updated.", "12-0": "strain", "12-1": "`object`", "12-2": "[Strain](doc:strain-object) that was used in this product.", "13-0": "strain.name", "13-1": "`string`", "13-2": "Name of the [strain](doc:strain-object) used in this product.", "14-0": "strain.ucpc", "14-1": "`string`", "14-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used in this product.", "15-0": "strain.link", "15-1": "`url`", "15-2": "Link to the [strain](doc:strain-object) used in this product in the Cannabis Reports API.", "16-0": "labTest", "16-1": "`url`", "16-2": "Link to the PDF containing lab test information for this product.", "17-0": "thc", "17-1": "`string`", "17-2": "Milligrams of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this product.", "18-0": "cbd", "18-1": "`string`", "18-2": "Milligrams of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this product.", "6-0": "image", "6-1": "`url`", "6-2": "Link to the full size image for this product.", "4-0": "barcode", "4-1": "`url`", "4-2": "Link to the barcode for this product.", "19-0": "cannabis", "19-1": "`string`", "19-2": "Milligrams of cannabis in this product.", "20-0": "hashOil", "20-1": "`string`", "20-2": "Milligrams of hash oil in this product.", "11-0": "type", "11-2": "Type of cannabis product.", "11-1": "`string`", "21-0": "reviews", "21-1": "`object`", "21-2": "Object containing information on the reviews for the product.", "23-0": "reviews.link", "23-1": "`url`", "23-2": "Link to the reviews for the product." }, "cols": 3, "rows": 26 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Absorb CBD\",\n \"ucpc\": \"9XVU7XPL4JQQLU2M9A9G00000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/products/9XVU7XPL4JQQLU2M9A9G00000\",\n \"qr\": \"https://www.cannabisreports.com/product-reports/qr-code/absorb-cbd/absorb-cbd.png\",\n \"barcode\": \"https://www.cannabisreports.com/product-reports/barcode/absorb-cbd/absorb-cbd.png\",\n \"url\": \"https://www.cannabisreports.com/product-reports/absorb-cbd/absorb-cbd\",\n \"image\": \"https://www.cannabisreports.com/images/products/c/full_cb900a5edb9cce37ce721a4460bd3b22a8434d76.jpg\",\n \"producer\": {\n \"name\": \"Absorb CBD\",\n \"ucpc\": \"0000000000QQLU20000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000QQLU20000000000\"\n },\n \"type\": \"topical\",\n \"strain\": {\n \"name\": \"ACDC (AC/DC)\",\n \"ucpc\": \"9XVU7XPL4J000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7XPL4J000000000000000\"\n },\n \"labTest\": \"https://www.cannabisreports.com/lab-tests/f/f08f252c9a66869a232a6f97e0af91c0d602293b.pdf\",\n \"thc\": \"8mg\",\n \"cbd\": \"200mg\",\n \"cannabis\": false,\n \"hashOil\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/products/9XVU7XPL4JQQLU2M9A9G00000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2015-04-22 18:43:10\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-05-15 18:33:46\",\n \"timezone\": \"UTC\"\n }\n }", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Product Endpoints" } [/block] Here are some of the results available from the different product endpoints: [block:parameters] { "data": { "0-0": "[/products](doc:products)", "0-1": "Gets a paginated list of products with optional sorting.", "1-0": "[/products/type/:productType](doc:products-type-producttype)", "1-1": "Gets a paginated list of products for a given type with optional sorting.", "2-1": "Gets an individual product based on the UCPC.", "2-0": "[/products/:ucpc](doc:products-ucpc)", "3-0": "[/products/:ucpc/reviews](doc:products-ucpc-reviews)", "3-1": "Gets the reviews for a cannabis product.", "4-0": "[/products/:ucpc/effectsFlavors](doc:products-ucpc-effectsflavors)", "4-1": "Gets the average effects and flavors from reviews for this product.", "5-0": "[/products/:ucpc/producer](doc:products-ucpc-producer)", "5-1": "Gets the producer for a given product.", "6-0": "[/products/:ucpc/strain](doc:products-ucpc-strain)", "6-1": "Gets the information about a strain for a product with the given UCPC.", "7-0": "[/products/:ucpc/availability/geo/:lat/:lng/:radius](doc:products-ucpc-availability-geo-lat-lng-radius)", "7-1": "Get information about the availability of a product using latitude and longitude.", "h-0": "Endpoint", "h-1": "Result" }, "cols": 2, "rows": 8 } [/block]
Cannabis products cover a wide variety of additional products that contain cannabis. Anything that wouldn't be consumed like an [edible](doc:edible-object) or [extract](doc:extract-object) falls into this category. We also have pre-rolled cannabis in this category. The main forms of products that Cannabis Reports recognizes are: * [Bath](https://www.cannabisreports.com/product-reports/bath) * [Topical](https://www.cannabisreports.com/product-reports/topical) * [Skin Care](https://www.cannabisreports.com/product-reports/skin-care) * [Pre-Roll](https://www.cannabisreports.com/product-reports/pre-roll) We also support "[Other](https://www.cannabisreports.com/product-reports/other)" types of products. Some examples are: * Lip Balm * Massage Oil * Personal Lubricant Producers measure the amount of cannabis in their products in a variety of ways. We recognize 4 ways for measuring the cannabis contents: * [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) mg * [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) mg * Cannabis mg * Hash Oil mg More information about cannabis products can be found in our FAQ here: https://www.cannabisreports.com/faq/typesconsumption/what-is-a-cannabis-product [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the product.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this product.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the product in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this product.", "5-0": "url", "5-1": "`url`", "5-2": "Link to the product listing on the Cannabis Reports website.", "7-0": "producer", "7-1": "`object`", "7-2": "Information about the [producer](doc:producer-object) that created the product.", "8-0": "producer.name", "8-1": "`string`", "8-2": "Name of the [producer](doc:producer-object) of the product.", "9-0": "producer.ucpc", "9-1": "`string`", "9-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) for the [producer](doc:producer-object).", "10-0": "producer.link", "10-1": "`url`", "10-2": "Link to the [producer](doc:producer-object) in the Cannabis Reports API.", "22-0": "reviews.count", "22-1": "`integer`", "22-2": "Number of reviews for the product.", "24-0": "createdAt", "24-1": "`object`", "24-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the product was added.", "25-0": "updatedAt", "25-1": "`object`", "25-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the product was updated.", "12-0": "strain", "12-1": "`object`", "12-2": "[Strain](doc:strain-object) that was used in this product.", "13-0": "strain.name", "13-1": "`string`", "13-2": "Name of the [strain](doc:strain-object) used in this product.", "14-0": "strain.ucpc", "14-1": "`string`", "14-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the [strain](doc:strain-object) used in this product.", "15-0": "strain.link", "15-1": "`url`", "15-2": "Link to the [strain](doc:strain-object) used in this product in the Cannabis Reports API.", "16-0": "labTest", "16-1": "`url`", "16-2": "Link to the PDF containing lab test information for this product.", "17-0": "thc", "17-1": "`string`", "17-2": "Milligrams of [THC](https://www.cannabisreports.com/faq/cannabis-community/what-is-thc-tetrahydrocannabinol) in this product.", "18-0": "cbd", "18-1": "`string`", "18-2": "Milligrams of [CBD](https://www.cannabisreports.com/faq/cannabis-community/what-is-cbd-cannabidiol) in this product.", "6-0": "image", "6-1": "`url`", "6-2": "Link to the full size image for this product.", "4-0": "barcode", "4-1": "`url`", "4-2": "Link to the barcode for this product.", "19-0": "cannabis", "19-1": "`string`", "19-2": "Milligrams of cannabis in this product.", "20-0": "hashOil", "20-1": "`string`", "20-2": "Milligrams of hash oil in this product.", "11-0": "type", "11-2": "Type of cannabis product.", "11-1": "`string`", "21-0": "reviews", "21-1": "`object`", "21-2": "Object containing information on the reviews for the product.", "23-0": "reviews.link", "23-1": "`url`", "23-2": "Link to the reviews for the product." }, "cols": 3, "rows": 26 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Absorb CBD\",\n \"ucpc\": \"9XVU7XPL4JQQLU2M9A9G00000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/products/9XVU7XPL4JQQLU2M9A9G00000\",\n \"qr\": \"https://www.cannabisreports.com/product-reports/qr-code/absorb-cbd/absorb-cbd.png\",\n \"barcode\": \"https://www.cannabisreports.com/product-reports/barcode/absorb-cbd/absorb-cbd.png\",\n \"url\": \"https://www.cannabisreports.com/product-reports/absorb-cbd/absorb-cbd\",\n \"image\": \"https://www.cannabisreports.com/images/products/c/full_cb900a5edb9cce37ce721a4460bd3b22a8434d76.jpg\",\n \"producer\": {\n \"name\": \"Absorb CBD\",\n \"ucpc\": \"0000000000QQLU20000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000QQLU20000000000\"\n },\n \"type\": \"topical\",\n \"strain\": {\n \"name\": \"ACDC (AC/DC)\",\n \"ucpc\": \"9XVU7XPL4J000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7XPL4J000000000000000\"\n },\n \"labTest\": \"https://www.cannabisreports.com/lab-tests/f/f08f252c9a66869a232a6f97e0af91c0d602293b.pdf\",\n \"thc\": \"8mg\",\n \"cbd\": \"200mg\",\n \"cannabis\": false,\n \"hashOil\": false,\n \"reviews\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/products/9XVU7XPL4JQQLU2M9A9G00000/reviews\"\n },\n \"createdAt\": {\n \"datetime\": \"2015-04-22 18:43:10\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-05-15 18:33:46\",\n \"timezone\": \"UTC\"\n }\n }", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Product Endpoints" } [/block] Here are some of the results available from the different product endpoints: [block:parameters] { "data": { "0-0": "[/products](doc:products)", "0-1": "Gets a paginated list of products with optional sorting.", "1-0": "[/products/type/:productType](doc:products-type-producttype)", "1-1": "Gets a paginated list of products for a given type with optional sorting.", "2-1": "Gets an individual product based on the UCPC.", "2-0": "[/products/:ucpc](doc:products-ucpc)", "3-0": "[/products/:ucpc/reviews](doc:products-ucpc-reviews)", "3-1": "Gets the reviews for a cannabis product.", "4-0": "[/products/:ucpc/effectsFlavors](doc:products-ucpc-effectsflavors)", "4-1": "Gets the average effects and flavors from reviews for this product.", "5-0": "[/products/:ucpc/producer](doc:products-ucpc-producer)", "5-1": "Gets the producer for a given product.", "6-0": "[/products/:ucpc/strain](doc:products-ucpc-strain)", "6-1": "Gets the information about a strain for a product with the given UCPC.", "7-0": "[/products/:ucpc/availability/geo/:lat/:lng/:radius](doc:products-ucpc-availability-geo-lat-lng-radius)", "7-1": "Get information about the availability of a product using latitude and longitude.", "h-0": "Endpoint", "h-1": "Result" }, "cols": 2, "rows": 8 } [/block]
{"__v":0,"_id":"5539939a69c2630d00a85547","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products?sort=-updatedAt&page=3"}]},"params":[{"_id":"552c3ee10b701a1700470d86","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"552c3fc1d9f89e0d0015a5b3","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Cherry Kola - Pre-roll\",\n            \"ucpc\": \"9XVU7NK3PEGLAJ372X4F00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/products/9XVU7NK3PEGLAJ372X4F00000\",\n            \"qr\": \"https://www.cannabisreports.com/product-reports/qr-code/emeralds/cherry-kola.png\",\n            \"barcode\": \"https://www.cannabisreports.com/product-reports/barcode/emeralds/cherry-kola.png\",\n            \"url\": \"https://www.cannabisreports.com/product-reports/emeralds/cherry-kola\",\n            \"image\": \"https://www.cannabisreports.com/images/products/1/full_181ed48f2c03407f9ae23f6e520846755e678f04.jpg\",\n            \"producer\": {\n                \"name\": \"Emeralds\",\n                \"ucpc\": \"0000000000GLAJ30000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000GLAJ30000000000\"\n            },\n            \"type\": \"pre-roll\",\n            \"strain\": {\n                \"name\": \"Cherry Kola\",\n                \"ucpc\": \"9XVU7NK3PE000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7NK3PE000000000000000\"\n            },\n            \"labTest\": false,\n            \"thc\": false,\n            \"cbd\": false,\n            \"cannabis\": false,\n            \"hashOil\": false,\n            \"reviews\": 0,\n            \"createdAt\": {\n                \"datetime\": \"2015-04-23 19:53:03\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-04-23 19:53:03\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 357,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 36,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/products?sort=-updatedAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/products?sort=-updatedAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/products"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `products` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"553990bb69c2630d00a85545","createdAt":"2015-04-24T00:51:38.024Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of products with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"products","sync_unique":"","title":"/products","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products

Gets a paginated list of products with optional sorting.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `products` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `products` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"553995b669c2630d00a85548","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products/type/pre-roll?sort=-updatedAt&page=3"}]},"params":[{"_id":"5536cabe8bb21f0d006f5d37","required":false,"desc":"The type of product you want to search through.","default":"pre-roll","type":"string","name":"productType","in":"path"},{"_id":"552c3ee10b701a1700470d86","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"552c3fc1d9f89e0d0015a5b3","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"XJ-13 - Pre-roll\",\n            \"ucpc\": \"9XVU7PU3PGGY79EP9XVP00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/products/9XVU7PU3PGGY79EP9XVP00000\",\n            \"qr\": \"https://www.cannabisreports.com/product-reports/qr-code/vines/xj-13.png\",\n            \"barcode\": \"https://www.cannabisreports.com/product-reports/barcode/vines/xj-13.png\",\n            \"url\": \"https://www.cannabisreports.com/product-reports/vines/xj-13\",\n            \"image\": \"https://www.cannabisreports.com/images/strains/no_image.png\",\n            \"producer\": {\n                \"name\": \"Vines\",\n                \"ucpc\": \"0000000000GY79E0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000GY79E0000000000\"\n            },\n            \"type\": \"pre-roll\",\n            \"strain\": {\n                \"name\": \"XJ-13\",\n                \"ucpc\": \"9XVU7PU3PG000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7PU3PG000000000000000\"\n            },\n            \"labTest\": false,\n            \"thc\": false,\n            \"cbd\": false,\n            \"cannabis\": false,\n            \"hashOil\": false,\n            \"reviews\": 0,\n            \"createdAt\": {\n                \"datetime\": \"2015-04-16 20:22:43\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-04-16 20:22:43\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 151,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 16,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/products/type/pre-roll?sort=-updatedAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/products/type/pre-roll?sort=-updatedAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/products/type/:productType"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"productType\"\n}\n[/block]\nOne of the various types of products you would like to filter by. See the `Cannabis Products` definition for valid types.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `products` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"553990bb69c2630d00a85545","createdAt":"2015-04-24T01:00:38.021Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of products for a given type with optional sorting.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"products-type-producttype","sync_unique":"","title":"/products/type/:productType","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products/type/:productType

Gets a paginated list of products for a given type with optional sorting.

Path Params

productType:
stringpre-roll
The type of product you want to search through.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "productType" } [/block] One of the various types of products you would like to filter by. See the `Cannabis Products` definition for valid types. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `products` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "productType" } [/block] One of the various types of products you would like to filter by. See the `Cannabis Products` definition for valid types. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `products` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"553a6c570074c80d00621bd9","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products/9XVU7NK3PEGLAJ372X4F00000 ","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"9XVU7NK3PEGLAJ372X4F00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis product you want information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Cherry Kola - Pre-roll\",\n        \"ucpc\": \"9XVU7NK3PEGLAJ372X4F00000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/products/9XVU7NK3PEGLAJ372X4F00000\",\n        \"qr\": \"https://www.cannabisreports.com/product-reports/qr-code/emeralds/cherry-kola.png\",\n        \"barcode\": \"https://www.cannabisreports.com/product-reports/barcode/emeralds/cherry-kola.png\",\n        \"url\": \"https://www.cannabisreports.com/product-reports/emeralds/cherry-kola\",\n        \"image\": \"https://www.cannabisreports.com/images/products/1/full_181ed48f2c03407f9ae23f6e520846755e678f04.jpg\",\n        \"producer\": {\n            \"name\": \"Emeralds\",\n            \"ucpc\": \"0000000000GLAJ30000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000GLAJ30000000000\"\n        },\n        \"type\": \"pre-roll\",\n        \"strain\": {\n            \"name\": \"Cherry Kola\",\n            \"ucpc\": \"9XVU7NK3PE000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7NK3PE000000000000000\"\n        },\n        \"labTest\": false,\n        \"thc\": false,\n        \"cbd\": false,\n        \"cannabis\": false,\n        \"hashOil\": false,\n        \"reviews\": 0,\n        \"createdAt\": {\n            \"datetime\": \"2015-04-23 19:53:03\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-04-23 19:53:03\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a product with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/products/:ucpc"},"body":"","category":"553990bb69c2630d00a85545","createdAt":"2015-04-24T16:16:23.337Z","editedParams":true,"editedParams2":true,"excerpt":"Gets an individual product based on the UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"products-ucpc","sync_unique":"","title":"/products/:ucpc","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products/:ucpc

Gets an individual product based on the UCPC.

Path Params

ucpc:
required
string9XVU7NK3PEGLAJ372X4F00000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis product you want information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"553a6ca736d0100d004b353f","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products/9XVU7NK3PEGLAJ372X4F00000/user","name":""}]},"params":[{"_id":"552fd625633a5b0d00e99e26","default":"9XVU7NK3PEGLAJ372X4F00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you want the user from.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"nickname\": \"Shelly\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/users/shelly\",\n        \"tagline\": \"Smoke Reporter\",\n        \"url\": \"https://www.cannabisreports.com/user/profile/shelly\",\n        \"slug\": \"shelly\",\n        \"createdAt\": {\n            \"datetime\": \"2014-06-21 15:20:29\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-05-06 22:10:38\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a product with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/products/:ucpc/user"},"body":"","category":"553990bb69c2630d00a85545","createdAt":"2015-04-24T16:17:43.517Z","editedParams":true,"editedParams2":true,"excerpt":"Get the user who added the product to the database.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55232972e2de0a3500f0a2df","slug":"products-ucpc-user","sync_unique":"","title":"/products/:ucpc/user","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products/:ucpc/user

Get the user who added the product to the database.

Path Params

ucpc:
required
string9XVU7NK3PEGLAJ372X4F00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you want the user from.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"553a6d2b69c2630d00a855dd","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products/0000000000C6FZLK664400000/reviews","name":""}]},"params":[{"_id":"552fd5a9f99ae00d00e054d2","default":"0000000000C6FZLK664400000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you would like reviews for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/reviews/4d5ade152bab3bb1ec0451e4dd942377ab0b0e98\",\n            \"url\": \"https://www.cannabisreports.com/smoke-reports/2015/03/17/4d5ade152bab3bb1ec0451e4dd942377ab0b0e98/jbcrockett\",\n            \"euphoria\": null,\n            \"creativity\": null,\n            \"pain_relief\": null,\n            \"appetite_gain\": null,\n            \"calming\": \"2\",\n            \"anxiety\": null,\n            \"spicy\": null,\n            \"earthy\": null,\n            \"fruity\": null,\n            \"sour\": null,\n            \"dry_mouth\": null,\n            \"createdAt\": {\n                \"datetime\": \"2015-03-17 00:22:42\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-03-17 00:22:42\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 2,\n            \"count\": 2,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n}      ","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find an edible with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/products/:ucpc/reviews"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"Page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"553990bb69c2630d00a85545","createdAt":"2015-04-24T16:19:55.198Z","editedParams":true,"editedParams2":true,"excerpt":"Get the reviews for a cannabis product.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55232972e2de0a3500f0a2df","slug":"products-ucpc-reviews","sync_unique":"","title":"/products/:ucpc/reviews","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products/:ucpc/reviews

Get the reviews for a cannabis product.

Path Params

ucpc:
required
string0000000000C6FZLK664400000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you would like reviews for.
[block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":0,"_id":"553a6d74861cb10d00e328e3","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products/0000000000C6FZLK664400000/effectsFlavors","name":""}]},"params":[{"_id":"552fd68ef99ae00d00e054d7","default":"0000000000C6FZLK664400000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you'd like the effects and flavors for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": {\n        \"euphoria\": null,\n        \"creativity\": null,\n        \"calming\": \"2.0000\",\n        \"numbness\": \"4.0000\",\n        \"appetite_gain\": null,\n        \"dry_mouth\": null,\n        \"fruity\": null,\n        \"spicy\": null,\n        \"earthy\": null,\n        \"sour\": null,\n        \"sweet\": null,\n        \"pine\": null,\n        \"anxiety\": null,\n        \"reviews\": 2\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find an edible with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/products/:ucpc/effectsFlavors"},"body":"","category":"553990bb69c2630d00a85545","createdAt":"2015-04-24T16:21:08.769Z","editedParams":true,"editedParams2":true,"excerpt":"Get the average effects and flavors from reviews for this product.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55232972e2de0a3500f0a2df","slug":"products-ucpc-effectsflavors","sync_unique":"","title":"/products/:ucpc/effectsFlavors","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products/:ucpc/effectsFlavors

Get the average effects and flavors from reviews for this product.

Path Params

ucpc:
required
string0000000000C6FZLK664400000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you'd like the effects and flavors for.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"553a6de736d0100d004b3544","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products/9XVU7NK3PEGLAJ372X4F00000/producer","name":""}]},"params":[{"_id":"553536b71fd5700d00f863b1","default":"9XVU7NK3PEGLAJ372X4F00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you want the [producer](doc:producer-object) for.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Emeralds\",\n        \"ucpc\": \"0000000000GLAJ30000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000GLAJ30000000000\",\n        \"qr\": \"https://www.cannabisreports.com/producer-reports/emeralds/qr-code\",\n        \"url\": \"https://www.cannabisreports.com/producer-reports/emeralds\",\n        \"image\": \"https://www.cannabisreports.com/images/profile/6/full_6b79645bfa75a564da1d842d5afdb283ef5b7992.jpg\",\n        \"reviews\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000GLAJ30000000000/reviews\"\n        },\n        \"extracts\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000GLAJ30000000000/extracts\"\n        },\n        \"edibles\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000GLAJ30000000000/edibles\"\n        },\n        \"products\": {\n            \"count\": 36,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000GLAJ30000000000/products\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2015-03-16 18:15:49\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-03-16 18:17:22\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a product with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/products/:ucpc/producer"},"body":"More information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.","category":"553990bb69c2630d00a85545","createdAt":"2015-04-24T16:23:03.657Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the producer for a given product.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"55232972e2de0a3500f0a2df","slug":"products-ucpc-producer","sync_unique":"","title":"/products/:ucpc/producer","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products/:ucpc/producer

Gets the producer for a given product.

Path Params

ucpc:
required
string9XVU7NK3PEGLAJ372X4F00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you want the [producer](doc:producer-object) for.
More information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



More information about the various fields for the producer can be found in the [cannabis producer object](doc:producer-object) definition section.
{"__v":0,"_id":"553a6e43861cb10d00e328e5","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products/9XVU7NK3PEGLAJ372X4F00000/strain","name":""}]},"params":[{"_id":"55353cf1f3e2ce0d0019103f","default":"9XVU7NK3PEGLAJ372X4F00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you want [strain](doc:strain-object) information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Cherry Kola\",\n        \"ucpc\": \"9XVU7NK3PE000000000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7NK3PE000000000000000\",\n        \"qr\": \"https://www.cannabisreports.com/strain-reports/unknown-breeder/cherry-kola/qr-code.svg\",\n        \"url\": \"https://www.cannabisreports.com/strain-reports/unknown-breeder/cherry-kola\",\n        \"image\": \"https://www.cannabisreports.com/images/strains/8/full_8a60c17d63915c5d20b0a874561042686a70b825.jpg\",\n        \"seedCompany\": {\n            \"name\": \"Unknown Breeder\",\n            \"ucpc\": \"9XVU700000000000000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/9XVU700000000000000000000\"\n        },\n        \"genetics\": {\n            \"names\": false,\n            \"ucpc\": false,\n            \"link\": false\n        },\n        \"lineage\": [],\n        \"children\": {\n            \"count\": 1,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7NK3PE000000000000000/children\"\n        },\n        \"reviews\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7NK3PE000000000000000/reviews\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2014-11-17 22:34:57\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2014-11-17 22:34:57\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a product with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/products/:ucpc/strain"},"body":"","category":"553990bb69c2630d00a85545","createdAt":"2015-04-24T16:24:35.535Z","editedParams":true,"editedParams2":true,"excerpt":"Gets the information about a strain for a product with the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"55232972e2de0a3500f0a2df","slug":"products-ucpc-strain","sync_unique":"","title":"/products/:ucpc/strain","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products/:ucpc/strain

Gets the information about a strain for a product with the given UCPC.

Path Params

ucpc:
required
string9XVU7NK3PEGLAJ372X4F00000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the product you want [strain](doc:strain-object) information about.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"554a804ed665ae0d00383f74","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/products/W74AFGH22ZWVWRKAKTRV00000/availability/geo/37.7749295/-122.4194155/25","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"W74AFGH22ZWVWRKAKTRV00000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis product you want availability for.","name":"ucpc","required":true,"type":"string","in":"path"},{"_id":"554a69e7156a480d00e2924f","required":true,"desc":"Latitude for the center of your availability search.","default":"37.7749295","type":"string","name":"lat","in":"path"},{"_id":"554a69e7156a480d00e2924e","required":true,"desc":"Longitude for the center of your availability search.","default":"-122.4194155","type":"string","name":"lng","in":"path"},{"_id":"554a69e7156a480d00e2924d","default":"25","desc":"Radius to search for in miles, max 25.","name":"radius","required":false,"type":"int","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Blueberry - Pre-roll\",\n            \"ucpc\": \"W74AFGH22ZWVWRKAKTRV00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/products/W74AFGH22ZWVWRKAKTRV00000\",\n            \"type\": \"product\",\n            \"location\": {\n                \"name\": \"BASA, Bay Area Safe Alternatives Inc.\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/basa-bay-area-safe-alternatives-inc\",\n                \"lat\": \"37.7760758\",\n                \"lng\": \"-122.4385182\"\n            },\n            \"price\": \"16.00\",\n            \"price_half_gram\": null,\n            \"price_gram\": null,\n            \"price_eighth\": null,\n            \"price_quarter\": null,\n            \"price_half_ounce\": null,\n            \"price_ounce\": null,\n            \"createdAt\": {\n                \"datetime\": \"2014-05-21 02:03:34\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2014-05-21 04:47:38\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        { ... }\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 9,\n            \"count\": 9,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a product with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/products/:ucpc/availability/geo/:lat/:lng/:radius"},"body":"This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular product.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"Page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"553990bb69c2630d00a85545","createdAt":"2015-05-06T20:57:50.389Z","editedParams":true,"editedParams2":true,"excerpt":"Get information about the availability of a product using latitude and longitude.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"55232972e2de0a3500f0a2df","slug":"products-ucpc-availability-geo-lat-lng-radius","sync_unique":"","title":"/products/:ucpc/availability/geo/:lat/:lng/:radius","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/products/:ucpc/availability/geo/:lat/:lng/:radius

Get information about the availability of a product using latitude and longitude.

Path Params

ucpc:
required
stringW74AFGH22ZWVWRKAKTRV00000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis product you want availability for.
lat:
required
string37.7749295
Latitude for the center of your availability search.
lng:
required
string-122.4194155
Longitude for the center of your availability search.
radius:
integer25
Radius to search for in miles, max 25.
This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular product. [block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for this particular product. [block:api-header] { "type": "options", "title": "Page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":9,"_id":"553ebdf08feab90d0059daa4","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis producers are the ones that create all of the cannabis [flowers](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), and other [products](doc:product-object) we know and love.\n\nMore information about cannabis producers can be found in our FAQ here:\n\nhttps://www.cannabisreports.com/faq/cannabis-community/what-is-a-cannabis-producer\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Name of the producer.\",\n    \"1-0\": \"ucpc\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) code for this producer.\",\n    \"2-0\": \"link\",\n    \"2-1\": \"`url`\",\n    \"2-2\": \"Link to the producer in the Cannabis Reports API.\",\n    \"3-0\": \"qr\",\n    \"3-1\": \"`url`\",\n    \"3-2\": \"Link to the QR code for this producer.\",\n    \"4-0\": \"url\",\n    \"4-1\": \"`url`\",\n    \"4-2\": \"Link to the producer listing on the Cannabis Reports website.\",\n    \"5-0\": \"image\",\n    \"5-1\": \"`url`\",\n    \"5-2\": \"Link to the full size logo image for this producer.\",\n    \"7-0\": \"reviews.count\",\n    \"7-1\": \"`integer`\",\n    \"7-2\": \"The number of reviews for all of the items this producer makes.\",\n    \"10-0\": \"extracts.count\",\n    \"10-1\": \"`integer`\",\n    \"10-2\": \"The number of [extracts](doc:extract-object) for this producer.\",\n    \"13-0\": \"edibles.count\",\n    \"13-1\": \"`integer`\",\n    \"13-2\": \"The number of [edibles](doc:edible-object) for this producer.\",\n    \"16-0\": \"products.count\",\n    \"16-1\": \"`integer`\",\n    \"16-2\": \"The number of [products](doc:product-object) for this producer.\",\n    \"18-0\": \"createdAt\",\n    \"19-0\": \"updatedAt\",\n    \"19-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the producer was updated.\",\n    \"18-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the producer was added.\",\n    \"18-1\": \"`object`\",\n    \"19-1\": \"`object`\",\n    \"6-0\": \"reviews\",\n    \"6-1\": \"`object`\",\n    \"6-2\": \"Information on the reviews for all of the cannabis items this producer makes.\",\n    \"8-0\": \"reviews.link\",\n    \"8-1\": \"`url`\",\n    \"8-2\": \"Link to the reviews for all of the items this producer makes in the Cannabis Reports API.\",\n    \"9-0\": \"extracts\",\n    \"9-1\": \"`object`\",\n    \"9-2\": \"Information on all of the [extracts](doc:extract-object) that this producer makes.\",\n    \"11-0\": \"extracts.link\",\n    \"11-1\": \"`url`\",\n    \"11-2\": \"Link to the [extracts](doc:extract-object) that this producer makes in the Cannabis Reports API.\",\n    \"12-0\": \"edibles\",\n    \"12-1\": \"`object`\",\n    \"12-2\": \"Information on all of the [edibles](doc:edible-object) that this producer makes.\",\n    \"14-0\": \"edibles.link\",\n    \"14-1\": \"`url`\",\n    \"15-0\": \"products\",\n    \"15-1\": \"`object`\",\n    \"17-0\": \"products.link\",\n    \"17-1\": \"`url`\",\n    \"14-2\": \"Link to the [edibles](doc:edible-object) that this producer makes in the Cannabis Reports API.\",\n    \"17-2\": \"Link to the [products](doc:product-object) that this producer makes in the Cannabis Reports API.\",\n    \"15-2\": \"Information on all of the [products](doc:product-object) that this producer makes.\"\n  },\n  \"cols\": 3,\n  \"rows\": 20\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"Kiva\\\",\\n    \\\"ucpc\\\": \\\"0000000000L6M7E0000000000\\\",\\n    \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000\\\",\\n    \\\"qr\\\": \\\"https://www.cannabisreports.com/producer-reports/kiva/qr-code\\\",\\n    \\\"url\\\": \\\"https://www.cannabisreports.com/producer-reports/kiva\\\",\\n    \\\"image\\\": \\\"https://www.cannabisreports.com/images/profile/8/full_8b44ce75bfba676790018d8a1d275d4d736883a9.jpg\\\",\\n    \\\"reviews\\\": {\\n        \\\"count\\\": 4,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/reviews\\\"\\n    },\\n    \\\"extracts\\\": {\\n        \\\"count\\\": 0,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/extracts\\\"\\n    },\\n    \\\"edibles\\\": {\\n        \\\"count\\\": 16,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/edibles\\\"\\n    },\\n    \\\"products\\\": {\\n        \\\"count\\\": 0,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/products\\\"\\n    },\\n    \\\"createdAt\\\": {\\n        \\\"datetime\\\": \\\"2014-07-09 22:41:29\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    },\\n    \\\"updatedAt\\\": {\\n        \\\"datetime\\\": \\\"2015-05-05 23:19:23\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Explore Producer Endpoints\"\n}\n[/block]\nHere are some of the results available from the different producer endpoints:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint\",\n    \"h-1\": \"Result\",\n    \"0-0\": \"[/producers](doc:producers)\",\n    \"0-1\": \"Gets a paginated list of producers from the system.\",\n    \"1-1\": \"Gets information about an individual producer based on the given UCPC.\",\n    \"1-0\": \"[/producers/:ucpc](doc:producers-ucpc)\",\n    \"2-0\": \"[/producers/:ucpc/extracts](doc:producers-ucpc-extracts)\",\n    \"2-1\": \"Gets a paginated list of extracts for a producer with the given UCPC.\",\n    \"3-0\": \"[/producers/:ucpc/edibles](doc:producers-ucpc-edibles)\",\n    \"3-1\": \"Gets a paginated list of edibles for a producer with the given UCPC.\",\n    \"4-0\": \"[/producers/:ucpc/products](doc:producers-ucpc-products)\",\n    \"4-1\": \"Gets a paginated list of products for a producer with the given UCPC.\",\n    \"5-0\": \"[/producers/:ucpc/availability/geo/:lat/:lng/:radius](doc:producers-ucpc-availability-geo-lat-lng-radius)\",\n    \"5-1\": \"Get information about the availability of everything from a producer using latitude and longitude.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","category":"553ebe1b6ab7691900ee727c","createdAt":"2015-04-27T22:53:36.742Z","excerpt":"Cannabis producers in the Cannabis Reports system.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"producer-object","sync_unique":"","title":"Producer Object","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Producer Object

Cannabis producers in the Cannabis Reports system.

Cannabis producers are the ones that create all of the cannabis [flowers](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), and other [products](doc:product-object) we know and love. More information about cannabis producers can be found in our FAQ here: https://www.cannabisreports.com/faq/cannabis-community/what-is-a-cannabis-producer [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the producer.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this producer.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the producer in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this producer.", "4-0": "url", "4-1": "`url`", "4-2": "Link to the producer listing on the Cannabis Reports website.", "5-0": "image", "5-1": "`url`", "5-2": "Link to the full size logo image for this producer.", "7-0": "reviews.count", "7-1": "`integer`", "7-2": "The number of reviews for all of the items this producer makes.", "10-0": "extracts.count", "10-1": "`integer`", "10-2": "The number of [extracts](doc:extract-object) for this producer.", "13-0": "edibles.count", "13-1": "`integer`", "13-2": "The number of [edibles](doc:edible-object) for this producer.", "16-0": "products.count", "16-1": "`integer`", "16-2": "The number of [products](doc:product-object) for this producer.", "18-0": "createdAt", "19-0": "updatedAt", "19-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the producer was updated.", "18-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the producer was added.", "18-1": "`object`", "19-1": "`object`", "6-0": "reviews", "6-1": "`object`", "6-2": "Information on the reviews for all of the cannabis items this producer makes.", "8-0": "reviews.link", "8-1": "`url`", "8-2": "Link to the reviews for all of the items this producer makes in the Cannabis Reports API.", "9-0": "extracts", "9-1": "`object`", "9-2": "Information on all of the [extracts](doc:extract-object) that this producer makes.", "11-0": "extracts.link", "11-1": "`url`", "11-2": "Link to the [extracts](doc:extract-object) that this producer makes in the Cannabis Reports API.", "12-0": "edibles", "12-1": "`object`", "12-2": "Information on all of the [edibles](doc:edible-object) that this producer makes.", "14-0": "edibles.link", "14-1": "`url`", "15-0": "products", "15-1": "`object`", "17-0": "products.link", "17-1": "`url`", "14-2": "Link to the [edibles](doc:edible-object) that this producer makes in the Cannabis Reports API.", "17-2": "Link to the [products](doc:product-object) that this producer makes in the Cannabis Reports API.", "15-2": "Information on all of the [products](doc:product-object) that this producer makes." }, "cols": 3, "rows": 20 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Kiva\",\n \"ucpc\": \"0000000000L6M7E0000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000\",\n \"qr\": \"https://www.cannabisreports.com/producer-reports/kiva/qr-code\",\n \"url\": \"https://www.cannabisreports.com/producer-reports/kiva\",\n \"image\": \"https://www.cannabisreports.com/images/profile/8/full_8b44ce75bfba676790018d8a1d275d4d736883a9.jpg\",\n \"reviews\": {\n \"count\": 4,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/reviews\"\n },\n \"extracts\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/extracts\"\n },\n \"edibles\": {\n \"count\": 16,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/edibles\"\n },\n \"products\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/products\"\n },\n \"createdAt\": {\n \"datetime\": \"2014-07-09 22:41:29\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-05-05 23:19:23\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Producer Endpoints" } [/block] Here are some of the results available from the different producer endpoints: [block:parameters] { "data": { "h-0": "Endpoint", "h-1": "Result", "0-0": "[/producers](doc:producers)", "0-1": "Gets a paginated list of producers from the system.", "1-1": "Gets information about an individual producer based on the given UCPC.", "1-0": "[/producers/:ucpc](doc:producers-ucpc)", "2-0": "[/producers/:ucpc/extracts](doc:producers-ucpc-extracts)", "2-1": "Gets a paginated list of extracts for a producer with the given UCPC.", "3-0": "[/producers/:ucpc/edibles](doc:producers-ucpc-edibles)", "3-1": "Gets a paginated list of edibles for a producer with the given UCPC.", "4-0": "[/producers/:ucpc/products](doc:producers-ucpc-products)", "4-1": "Gets a paginated list of products for a producer with the given UCPC.", "5-0": "[/producers/:ucpc/availability/geo/:lat/:lng/:radius](doc:producers-ucpc-availability-geo-lat-lng-radius)", "5-1": "Get information about the availability of everything from a producer using latitude and longitude." }, "cols": 2, "rows": 6 } [/block]
Cannabis producers are the ones that create all of the cannabis [flowers](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), and other [products](doc:product-object) we know and love. More information about cannabis producers can be found in our FAQ here: https://www.cannabisreports.com/faq/cannabis-community/what-is-a-cannabis-producer [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the producer.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) code for this producer.", "2-0": "link", "2-1": "`url`", "2-2": "Link to the producer in the Cannabis Reports API.", "3-0": "qr", "3-1": "`url`", "3-2": "Link to the QR code for this producer.", "4-0": "url", "4-1": "`url`", "4-2": "Link to the producer listing on the Cannabis Reports website.", "5-0": "image", "5-1": "`url`", "5-2": "Link to the full size logo image for this producer.", "7-0": "reviews.count", "7-1": "`integer`", "7-2": "The number of reviews for all of the items this producer makes.", "10-0": "extracts.count", "10-1": "`integer`", "10-2": "The number of [extracts](doc:extract-object) for this producer.", "13-0": "edibles.count", "13-1": "`integer`", "13-2": "The number of [edibles](doc:edible-object) for this producer.", "16-0": "products.count", "16-1": "`integer`", "16-2": "The number of [products](doc:product-object) for this producer.", "18-0": "createdAt", "19-0": "updatedAt", "19-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the producer was updated.", "18-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the producer was added.", "18-1": "`object`", "19-1": "`object`", "6-0": "reviews", "6-1": "`object`", "6-2": "Information on the reviews for all of the cannabis items this producer makes.", "8-0": "reviews.link", "8-1": "`url`", "8-2": "Link to the reviews for all of the items this producer makes in the Cannabis Reports API.", "9-0": "extracts", "9-1": "`object`", "9-2": "Information on all of the [extracts](doc:extract-object) that this producer makes.", "11-0": "extracts.link", "11-1": "`url`", "11-2": "Link to the [extracts](doc:extract-object) that this producer makes in the Cannabis Reports API.", "12-0": "edibles", "12-1": "`object`", "12-2": "Information on all of the [edibles](doc:edible-object) that this producer makes.", "14-0": "edibles.link", "14-1": "`url`", "15-0": "products", "15-1": "`object`", "17-0": "products.link", "17-1": "`url`", "14-2": "Link to the [edibles](doc:edible-object) that this producer makes in the Cannabis Reports API.", "17-2": "Link to the [products](doc:product-object) that this producer makes in the Cannabis Reports API.", "15-2": "Information on all of the [products](doc:product-object) that this producer makes." }, "cols": 3, "rows": 20 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Kiva\",\n \"ucpc\": \"0000000000L6M7E0000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000\",\n \"qr\": \"https://www.cannabisreports.com/producer-reports/kiva/qr-code\",\n \"url\": \"https://www.cannabisreports.com/producer-reports/kiva\",\n \"image\": \"https://www.cannabisreports.com/images/profile/8/full_8b44ce75bfba676790018d8a1d275d4d736883a9.jpg\",\n \"reviews\": {\n \"count\": 4,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/reviews\"\n },\n \"extracts\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/extracts\"\n },\n \"edibles\": {\n \"count\": 16,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/edibles\"\n },\n \"products\": {\n \"count\": 0,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/products\"\n },\n \"createdAt\": {\n \"datetime\": \"2014-07-09 22:41:29\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-05-05 23:19:23\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Producer Endpoints" } [/block] Here are some of the results available from the different producer endpoints: [block:parameters] { "data": { "h-0": "Endpoint", "h-1": "Result", "0-0": "[/producers](doc:producers)", "0-1": "Gets a paginated list of producers from the system.", "1-1": "Gets information about an individual producer based on the given UCPC.", "1-0": "[/producers/:ucpc](doc:producers-ucpc)", "2-0": "[/producers/:ucpc/extracts](doc:producers-ucpc-extracts)", "2-1": "Gets a paginated list of extracts for a producer with the given UCPC.", "3-0": "[/producers/:ucpc/edibles](doc:producers-ucpc-edibles)", "3-1": "Gets a paginated list of edibles for a producer with the given UCPC.", "4-0": "[/producers/:ucpc/products](doc:producers-ucpc-products)", "4-1": "Gets a paginated list of products for a producer with the given UCPC.", "5-0": "[/producers/:ucpc/availability/geo/:lat/:lng/:radius](doc:producers-ucpc-availability-geo-lat-lng-radius)", "5-1": "Get information about the availability of everything from a producer using latitude and longitude." }, "cols": 2, "rows": 6 } [/block]
{"__v":1,"_id":"553ebe428feab90d0059daa8","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/producers","name":""}]},"params":[{"_id":"553ebede6ab7691900ee727e","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"553ebede6ab7691900ee727d","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Jay's Prerolls\",\n            \"ucpc\": \"0000000000HXHNZ0000000000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000HXHNZ0000000000\",\n            \"qr\": \"https://www.cannabisreports.com/producer-reports/jays-prerolls/qr-code\",\n            \"url\": \"https://www.cannabisreports.com/producer-reports/jays-prerolls\",\n            \"image\": \"https://www.cannabisreports.com/images/profile/b/full_bd2e4dd184bc3317d0edae4fd20a6813816cacb9.jpg\",\n            \"reviews\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000HXHNZ0000000000/reviews\"\n            },\n            \"extracts\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000HXHNZ0000000000/extracts\"\n            },\n            \"edibles\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000HXHNZ0000000000/edibles\"\n            },\n            \"products\": {\n                \"count\": 3,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000HXHNZ0000000000/products\"\n            },\n            \"createdAt\": {\n                \"datetime\": \"2015-05-06 22:20:31\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-05-06 22:25:05\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 461,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 47,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/producers?page=2\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/producers"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `producers` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated, created, or alphabetically.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\",\n    \"4-0\": \"name\",\n    \"4-1\": \"Alphabetically stating with numeric producers. 0-9, A-Z.\",\n    \"5-0\": \"-name\",\n    \"5-1\": \"Alphabetically starting with Z and working back through numeric producers. Z-A, 9-0.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","category":"553ebe1b6ab7691900ee727c","createdAt":"2015-04-27T22:54:58.867Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of producers from the system.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"producers","sync_unique":"","title":"/producers","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/producers

Gets a paginated list of producers from the system.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `producers` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated, created, or alphabetically. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records.", "4-0": "name", "4-1": "Alphabetically stating with numeric producers. 0-9, A-Z.", "5-0": "-name", "5-1": "Alphabetically starting with Z and working back through numeric producers. Z-A, 9-0." }, "cols": 2, "rows": 6 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `producers` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated, created, or alphabetically. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records.", "4-0": "name", "4-1": "Alphabetically stating with numeric producers. 0-9, A-Z.", "5-0": "-name", "5-1": "Alphabetically starting with Z and working back through numeric producers. Z-A, 9-0." }, "cols": 2, "rows": 6 } [/block]
{"__v":0,"_id":"553ec25c4eb8a00d003092bf","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000","name":""}]},"params":[{"_id":"553ec25c4eb8a00d003092c0","default":"0000000000L6M7E0000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the producer you want information about.","name":"ucpc","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Kiva\",\n        \"ucpc\": \"0000000000L6M7E0000000000\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000\",\n        \"qr\": \"https://www.cannabisreports.com/producer-reports/kiva/qr-code\",\n        \"url\": \"https://www.cannabisreports.com/producer-reports/kiva\",\n        \"image\": \"https://www.cannabisreports.com/images/profile/8/full_8b44ce75bfba676790018d8a1d275d4d736883a9.jpg\",\n        \"reviews\": {\n            \"count\": 4,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/reviews\"\n        },\n        \"extracts\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/extracts\"\n        },\n        \"edibles\": {\n            \"count\": 16,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/edibles\"\n        },\n        \"products\": {\n            \"count\": 0,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/products\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2014-07-09 22:41:29\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-05-05 23:19:23\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a producer with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/producers/:ucpc"},"body":"More information about the various fields can be found in the [cannabis producer object](doc:producer-object) definition section.","category":"553ebe1b6ab7691900ee727c","createdAt":"2015-04-27T23:12:28.961Z","editedParams":true,"editedParams2":true,"excerpt":"Gets information about an individual producer based on the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"producers-ucpc","sync_unique":"","title":"/producers/:ucpc","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/producers/:ucpc

Gets information about an individual producer based on the given UCPC.

Path Params

ucpc:
required
string0000000000L6M7E0000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the producer you want information about.
More information about the various fields can be found in the [cannabis producer object](doc:producer-object) definition section.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



More information about the various fields can be found in the [cannabis producer object](doc:producer-object) definition section.
{"__v":0,"_id":"553ec01b8feab90d0059dab0","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/producers/0000000000VU7TG0000000000/extracts","name":""}]},"params":[{"_id":"553ec01b8feab90d0059dab3","default":"0000000000VU7TG0000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the producer you want [extracts](doc:extract-object) for.","name":"ucpc","required":true,"type":"string","in":"path"},{"_id":"553ec01b8feab90d0059dab2","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"553ec01b8feab90d0059dab1","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Blackberry Kush - Oil\",\n            \"ucpc\": \"9XVU79H97ZVU7TGC4LET00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/9XVU79H97ZVU7TGC4LET00000\",\n            \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/absolute-xtracts/unknown-breeder/blackberry-kush/oil.png\",\n            \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/absolute-xtracts/unknown-breeder/blackberry-kush/oil.png\",\n            \"url\": \"https://www.cannabisreports.com/extract-reports/absolute-xtracts/unknown-breeder/blackberry-kush/oil\",\n            \"image\": \"https://www.cannabisreports.com/images/extracts/oil.jpg\",\n            \"producer\": {\n                \"name\": \"Absolute Xtracts\",\n                \"ucpc\": \"0000000000VU7TG0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000VU7TG0000000000\"\n            },\n            \"type\": \"oil\",\n            \"strain\": {\n                \"name\": \"Blackberry Kush\",\n                \"ucpc\": \"9XVU79H97Z000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU79H97Z000000000000000\"\n            },\n            \"labTest\": false,\n            \"thc\": false,\n            \"cbd\": false,\n            \"reviews\": 0,\n            \"createdAt\": {\n                \"datetime\": \"2015-04-10 18:37:16\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-04-10 18:37:16\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 18,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 2,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000VU7TG0000000000/extracts?page=2\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a producer with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/producers/:ucpc/extracts"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"553ebe1b6ab7691900ee727c","createdAt":"2015-04-27T23:02:51.436Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of extracts for a producer with the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"producers-ucpc-extracts","sync_unique":"","title":"/producers/:ucpc/extracts","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/producers/:ucpc/extracts

Gets a paginated list of extracts for a producer with the given UCPC.

Path Params

ucpc:
required
string0000000000VU7TG0000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the producer you want [extracts](doc:extract-object) for.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"553ec0c06ab7691900ee7289","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/edibles","name":""}]},"params":[{"_id":"553ec01b8feab90d0059dab3","default":"0000000000L6M7E0000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the producer you want [edibles](doc:edible-object) for.","name":"ucpc","required":true,"type":"string","in":"path"},{"_id":"553ec01b8feab90d0059dab2","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"553ec01b8feab90d0059dab1","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Terra Blueberry Bites\",\n            \"ucpc\": \"0000000000L6M7ENLJVX00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/edibles/0000000000L6M7ENLJVX00000\",\n            \"qr\": \"https://www.cannabisreports.com/edible-reports/qr-code/kiva/terra-blueberry-bites\",\n            \"barcode\": \"https://www.cannabisreports.com/edible-reports/barcode/kiva/terra-blueberry-bites\",\n            \"url\": \"https://www.cannabisreports.com/edible-reports/kiva/terra-blueberry-bites\",\n            \"image\": \"https://www.cannabisreports.com/images/edibles/f/full_f29d34f36f40c96e26419caad6a668618bd417bb.jpg\",\n            \"producer\": {\n                \"name\": \"Kiva\",\n                \"ucpc\": \"0000000000L6M7E0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000\"\n            },\n            \"type\": \"chocolate\",\n            \"strain\": [],\n            \"labTest\": false,\n            \"thc\": \"120mg\",\n            \"cbd\": false,\n            \"cannabis\": false,\n            \"hashOil\": false,\n            \"reviews\": 2,\n            \"createdAt\": {\n                \"datetime\": \"2015-03-12 21:02:48\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-03-12 21:02:48\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 16,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 2,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000L6M7E0000000000/edibles?page=2\"\n            }\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a producer with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/producers/:ucpc/edibles"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"553ebe1b6ab7691900ee727c","createdAt":"2015-04-27T23:05:36.401Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of edibles for a producer with the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55232972e2de0a3500f0a2df","slug":"producers-ucpc-edibles","sync_unique":"","title":"/producers/:ucpc/edibles","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/producers/:ucpc/edibles

Gets a paginated list of edibles for a producer with the given UCPC.

Path Params

ucpc:
required
string0000000000L6M7E0000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the producer you want [edibles](doc:edible-object) for.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"553ec4396ab7691900ee728d","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/producers/0000000000N4E9N0000000000/products","name":""}]},"params":[{"_id":"553ec01b8feab90d0059dab3","default":"0000000000N4E9N0000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) of the producer you want [products](doc:product-object) for.","name":"ucpc","required":true,"type":"string","in":"path"},{"_id":"553ec01b8feab90d0059dab2","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"553ec01b8feab90d0059dab1","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"Herb Infused Joint - Lobelia - Pre-roll\",\n            \"ucpc\": \"0000000000N4E9N9XFK900000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/products/0000000000N4E9N9XFK900000\",\n            \"qr\": \"https://www.cannabisreports.com/product-reports/qr-code/divine-remedies/herb-infused-joint-lobelia.png\",\n            \"barcode\": \"https://www.cannabisreports.com/product-reports/barcode/divine-remedies/herb-infused-joint-lobelia.png\",\n            \"url\": \"https://www.cannabisreports.com/product-reports/divine-remedies/herb-infused-joint-lobelia\",\n            \"image\": \"https://www.cannabisreports.com/images/products/5/full_551aa62ec2dd145da3adc9eafe22ee4e4c331ee7.jpg\",\n            \"producer\": {\n                \"name\": \"Divine Remedies\",\n                \"ucpc\": \"0000000000N4E9N0000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000N4E9N0000000000\"\n            },\n            \"type\": \"pre-roll\",\n            \"strain\": [],\n            \"labTest\": false,\n            \"thc\": false,\n            \"cbd\": false,\n            \"cannabis\": false,\n            \"hashOil\": false,\n            \"reviews\": 0,\n            \"createdAt\": {\n                \"datetime\": \"2015-02-09 05:13:52\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-02-11 00:00:53\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 8,\n            \"count\": 8,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 1,\n            \"links\": []\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a producer with that UCPC.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/producers/:ucpc/products"},"body":"[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"553ebe1b6ab7691900ee727c","createdAt":"2015-04-27T23:20:25.920Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of products for a producer with the given UCPC.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55232972e2de0a3500f0a2df","slug":"producers-ucpc-products","sync_unique":"","title":"/producers/:ucpc/products","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/producers/:ucpc/products

Gets a paginated list of products for a producer with the given UCPC.

Path Params

ucpc:
required
string0000000000N4E9N0000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) of the producer you want [products](doc:product-object) for.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"554a81bcd665ae0d00383f81","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/producers/0000000000VU7TG0000000000/availability/geo/37.7749295/-122.4194155/25","name":""}]},"params":[{"_id":"552c43457820b80d00aa4f1a","default":"0000000000VU7TG0000000000","desc":"[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis producer you want availability for.","name":"ucpc","required":true,"type":"string","in":"path"},{"_id":"554a69e7156a480d00e2924f","required":true,"desc":"Latitude for the center of your availability search.","default":"37.7749295","type":"string","name":"lat","in":"path"},{"_id":"554a69e7156a480d00e2924e","required":true,"desc":"Longitude for the center of your availability search.","default":"-122.4194155","type":"string","name":"lng","in":"path"},{"_id":"554a69e7156a480d00e2924d","required":false,"desc":"Radius to search for in miles, max 25.","default":"10","type":"int","name":"radius","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Sour Diesel - Vaporizer Cartridge\",\n            \"ucpc\": \"9XVU7KVPFZVU7TGTLXET00000\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/9XVU7KVPFZVU7TGTLXET00000\",\n            \"type\": \"extract\",\n            \"location\": {\n                \"name\": \"SFFOGG\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/sffogg\",\n                \"lat\": \"37.7717311\",\n                \"lng\": \"-122.4165409\"\n            },\n            \"price\": null,\n            \"price_half_gram\": \"0.00\",\n            \"price_gram\": \"40.00\",\n            \"price_eighth\": null,\n            \"price_quarter\": null,\n            \"price_half_ounce\": null,\n            \"price_ounce\": null,\n            \"createdAt\": {\n                \"datetime\": \"2014-11-24 22:46:52\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-05-06 16:47:46\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        { ... }\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 152,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 16,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000VU7TG0000000000/availability/geo/37.7749295/-122.4194155/25?page=2\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a producer with that UCPC.\",\n    \"status_code\": 404\n}","language":"json","status":404}]},"settings":"","url":"/producers/:ucpc/availability/geo/:lat/:lng/:radius"},"body":"This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for all availability from this producer.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.","category":"553ebe1b6ab7691900ee727c","createdAt":"2015-05-06T21:03:56.032Z","editedParams":true,"editedParams2":true,"excerpt":"Get information about the availability of everything from a producer using latitude and longitude.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55232972e2de0a3500f0a2df","slug":"producers-ucpc-availability-geo-lat-lng-radius","sync_unique":"","title":"/producers/:ucpc/availability/geo/:lat/:lng/:radius","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/producers/:ucpc/availability/geo/:lat/:lng/:radius

Get information about the availability of everything from a producer using latitude and longitude.

Path Params

ucpc:
required
string0000000000VU7TG0000000000
[UCPC](doc:ucpc-universal-cannabis-product-code) for the cannabis producer you want availability for.
lat:
required
string37.7749295
Latitude for the center of your availability search.
lng:
required
string-122.4194155
Longitude for the center of your availability search.
radius:
integer10
Radius to search for in miles, max 25.
This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for all availability from this producer. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will provide a [paginated](doc:pagination) list of [item summary objects](doc:menu-item-summary-object) for all availability from this producer. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for this API call. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information.
{"__v":11,"_id":"5546779e6bea270d0047d522","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Cannabis Reports currently refers to all types of retailers in the API as a dispensary. Delivery services will not have an address associated with them, only a location. The dispensary menus are split into [strains](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), and [products](doc:product-object).\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Name of the dispensary.\",\n    \"1-0\": \"link\",\n    \"1-1\": \"`url`\",\n    \"1-2\": \"Link to the dispensary in the Cannabis Reports API.\",\n    \"2-0\": \"qr\",\n    \"2-1\": \"`url`\",\n    \"2-2\": \"Link to the QR code for this dispensary.\",\n    \"3-0\": \"url\",\n    \"3-1\": \"`url`\",\n    \"3-2\": \"Link to the dispensary listing on the Cannabis Reports website.\",\n    \"4-0\": \"image\",\n    \"4-1\": \"`url`\",\n    \"4-2\": \"Link to the full size logo image for this dispensary.\",\n    \"15-0\": \"reviews.count\",\n    \"15-1\": \"`integer`\",\n    \"15-2\": \"The number of reviews for items from this dispensary.\",\n    \"21-0\": \"extracts.count\",\n    \"21-1\": \"`integer`\",\n    \"21-2\": \"The number of [extracts](doc:extract-object) available at this dispensary.\",\n    \"22-0\": \"extracts.link\",\n    \"22-1\": \"`url`\",\n    \"22-2\": \"Link to [extracts](doc:extract-object) menu items available from this dispensary.\",\n    \"27-0\": \"products.count\",\n    \"27-1\": \"`integer`\",\n    \"27-2\": \"The number of [products](doc:product-object) available at this dispensary.\",\n    \"14-0\": \"reviews\",\n    \"14-1\": \"`object`\",\n    \"14-2\": \"Object containing information about reviews for this dispensary.\",\n    \"17-0\": \"strains\",\n    \"17-1\": \"`object`\",\n    \"17-2\": \"Object containing information about [strains](doc:strain-object) available at this dispensary.\",\n    \"16-0\": \"reviews.link\",\n    \"16-1\": \"`url`\",\n    \"16-2\": \"Link to the reviews for this dispensary in the Cannabis Reports API.\",\n    \"18-0\": \"strains.count\",\n    \"18-1\": \"`integer`\",\n    \"18-2\": \"The number of [flowers](doc:strain-object) available from the dispensary.\",\n    \"19-0\": \"strains.link\",\n    \"19-1\": \"`url`\",\n    \"19-2\": \"Link to [flower](doc:strain-object) menu items available from this dispensary.\",\n    \"20-0\": \"extracts\",\n    \"20-1\": \"`object`\",\n    \"20-2\": \"Object containing information about [extracts](doc:extract-object) available at this dispensary.\",\n    \"23-0\": \"edibles\",\n    \"23-1\": \"`object`\",\n    \"23-2\": \"Object containing information about [edibles](doc:edible-object) available at this dispensary.\",\n    \"24-0\": \"edibles.count\",\n    \"24-1\": \"`integer`\",\n    \"24-2\": \"Number of [edibles](doc:edible-object) available at this dispensary.\",\n    \"25-0\": \"edibles.link\",\n    \"25-1\": \"`url`\",\n    \"25-2\": \"Link to [edible](doc:edible-object) menu items available from this dispensary.\",\n    \"26-0\": \"products\",\n    \"26-1\": \"`object`\",\n    \"26-2\": \"Object containing information about [products](doc:product-object) available at this dispensary.\",\n    \"28-0\": \"products.link\",\n    \"28-1\": \"`url`\",\n    \"28-2\": \"Link to [product](doc:product-object) menu items available from this dispensary.\",\n    \"29-0\": \"updatedAt\",\n    \"29-1\": \"`object`\",\n    \"29-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the dispensary was updated.\",\n    \"30-0\": \"createdAt\",\n    \"30-1\": \"`object`\",\n    \"30-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the dispensary was added.\",\n    \"5-0\": \"state\",\n    \"5-1\": \"`string`\",\n    \"5-2\": \"Two character representation of the state this dispensary is in.\",\n    \"6-0\": \"city\",\n    \"6-1\": \"`string`\",\n    \"6-2\": \"City this dispensary is in.\",\n    \"13-0\": \"slug\",\n    \"13-1\": \"`string`\",\n    \"13-2\": \"Identifier for this dispensary; a combination of city and state.\",\n    \"7-0\": \"lat\",\n    \"7-1\": \"`string`\",\n    \"7-2\": \"Latitude of this dispensary.\",\n    \"8-0\": \"lng\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"Longitude of this dispensary.\",\n    \"9-0\": \"address\",\n    \"9-1\": \"`object`\",\n    \"9-2\": \"Object containing additional location information for this dispensary.\",\n    \"10-0\": \"address.address1\",\n    \"10-1\": \"`string`\",\n    \"10-2\": \"Street address for this dispensary.\",\n    \"11-0\": \"address.address2\",\n    \"11-1\": \"`string`\",\n    \"11-2\": \"Additional street address line for this dispensary.\",\n    \"12-0\": \"address.zip\",\n    \"12-1\": \"`string`\",\n    \"12-2\": \"Zip Code for this dispensary.\"\n  },\n  \"cols\": 3,\n  \"rows\": 31\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"Grass Roots\\\",\\n    \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots\\\",\\n    \\\"qr\\\": \\\"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/grass-roots/qr-code\\\",\\n    \\\"url\\\": \\\"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/grass-roots\\\",\\n    \\\"image\\\": \\\"https://www.cannabisreports.com/images/profile/5/full_5720f041410b18488b6e4b92c0a3ce598bec3ea8.jpg\\\",\\n    \\\"state\\\": \\\"CA\\\",\\n    \\\"city\\\": \\\"San Francisco\\\",\\n    \\\"slug\\\": \\\"ca/san-francisco/grass-roots\\\",\\n    \\\"lat\\\": \\\"37.7866941\\\",\\n    \\\"lng\\\": \\\"-122.4194293\\\",\\n    \\\"address\\\": {\\n        \\\"address1\\\": \\\"1077 Post Street\\\",\\n        \\\"address2\\\": \\\"\\\",\\n        \\\"zip\\\": \\\"94109\\\"\\n    },\\n    \\\"reviews\\\": {\\n        \\\"count\\\": 55,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/reviews\\\"\\n    },\\n    \\\"strains\\\": {\\n        \\\"count\\\": 39,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/strains\\\"\\n    },\\n    \\\"extracts\\\": {\\n        \\\"count\\\": 59,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/extracts\\\"\\n    },\\n    \\\"edibles\\\": {\\n        \\\"count\\\": 167,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/edibles\\\"\\n    },\\n    \\\"products\\\": {\\n        \\\"count\\\": 54,\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/products\\\"\\n    },\\n    \\\"createdAt\\\": {\\n        \\\"datetime\\\": \\\"2015-04-24 20:13:46\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    },\\n    \\\"updatedAt\\\": {\\n        \\\"datetime\\\": \\\"2015-04-24 20:13:46\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Explore Dispensary Endpoints\"\n}\n[/block]\nHere are some of the results available from the different dispensary endpoints:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"[/dispensaries](doc:dispensaries)\",\n    \"0-1\": \"Gets a paginated list of dispensaries from the system.\",\n    \"1-0\": \"[/dispensaries/:state/:city/:slug](doc:dispensaries-state-city-slug)\",\n    \"1-1\": \"Gets information about an individual dispensary based on the state, city, and slug.\",\n    \"2-0\": \"[/dispensaries/:state/:city/:slug/strains](doc:dispensaries-state-city-slug-strains)\",\n    \"2-1\": \"Gets a paginated list of strains for a dispensary from the given information.\",\n    \"3-0\": \"[/dispensaries/:state/:city/:slug/extracts](doc:dispensaries-state-city-slug-extracts)\",\n    \"3-1\": \"Gets a paginated list of extracts for a dispensary from the given information.\",\n    \"4-0\": \"[/dispensaries/:state/:city/:slug/edibles](doc:dispensaries-state-city-slug-edibles)\",\n    \"4-1\": \"Gets a paginated list of edibles for a dispensary from the given information.\",\n    \"5-0\": \"[/dispensaries/:state/:city/:slug/products](doc:dispensaries-state-city-slug-products)\",\n    \"5-1\": \"Gets a paginated list of products for a dispensary from the given information.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","category":"5546778b3dca710d004647a2","createdAt":"2015-05-03T19:31:42.618Z","excerpt":"Cannabis dispensaries, deliveries, and retailers in the Cannabis Reports system.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"55232972e2de0a3500f0a2df","slug":"dispensary-object","sync_unique":"","title":"Dispensary Object","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Dispensary Object

Cannabis dispensaries, deliveries, and retailers in the Cannabis Reports system.

Cannabis Reports currently refers to all types of retailers in the API as a dispensary. Delivery services will not have an address associated with them, only a location. The dispensary menus are split into [strains](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), and [products](doc:product-object). [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the dispensary.", "1-0": "link", "1-1": "`url`", "1-2": "Link to the dispensary in the Cannabis Reports API.", "2-0": "qr", "2-1": "`url`", "2-2": "Link to the QR code for this dispensary.", "3-0": "url", "3-1": "`url`", "3-2": "Link to the dispensary listing on the Cannabis Reports website.", "4-0": "image", "4-1": "`url`", "4-2": "Link to the full size logo image for this dispensary.", "15-0": "reviews.count", "15-1": "`integer`", "15-2": "The number of reviews for items from this dispensary.", "21-0": "extracts.count", "21-1": "`integer`", "21-2": "The number of [extracts](doc:extract-object) available at this dispensary.", "22-0": "extracts.link", "22-1": "`url`", "22-2": "Link to [extracts](doc:extract-object) menu items available from this dispensary.", "27-0": "products.count", "27-1": "`integer`", "27-2": "The number of [products](doc:product-object) available at this dispensary.", "14-0": "reviews", "14-1": "`object`", "14-2": "Object containing information about reviews for this dispensary.", "17-0": "strains", "17-1": "`object`", "17-2": "Object containing information about [strains](doc:strain-object) available at this dispensary.", "16-0": "reviews.link", "16-1": "`url`", "16-2": "Link to the reviews for this dispensary in the Cannabis Reports API.", "18-0": "strains.count", "18-1": "`integer`", "18-2": "The number of [flowers](doc:strain-object) available from the dispensary.", "19-0": "strains.link", "19-1": "`url`", "19-2": "Link to [flower](doc:strain-object) menu items available from this dispensary.", "20-0": "extracts", "20-1": "`object`", "20-2": "Object containing information about [extracts](doc:extract-object) available at this dispensary.", "23-0": "edibles", "23-1": "`object`", "23-2": "Object containing information about [edibles](doc:edible-object) available at this dispensary.", "24-0": "edibles.count", "24-1": "`integer`", "24-2": "Number of [edibles](doc:edible-object) available at this dispensary.", "25-0": "edibles.link", "25-1": "`url`", "25-2": "Link to [edible](doc:edible-object) menu items available from this dispensary.", "26-0": "products", "26-1": "`object`", "26-2": "Object containing information about [products](doc:product-object) available at this dispensary.", "28-0": "products.link", "28-1": "`url`", "28-2": "Link to [product](doc:product-object) menu items available from this dispensary.", "29-0": "updatedAt", "29-1": "`object`", "29-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was updated.", "30-0": "createdAt", "30-1": "`object`", "30-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was added.", "5-0": "state", "5-1": "`string`", "5-2": "Two character representation of the state this dispensary is in.", "6-0": "city", "6-1": "`string`", "6-2": "City this dispensary is in.", "13-0": "slug", "13-1": "`string`", "13-2": "Identifier for this dispensary; a combination of city and state.", "7-0": "lat", "7-1": "`string`", "7-2": "Latitude of this dispensary.", "8-0": "lng", "8-1": "`string`", "8-2": "Longitude of this dispensary.", "9-0": "address", "9-1": "`object`", "9-2": "Object containing additional location information for this dispensary.", "10-0": "address.address1", "10-1": "`string`", "10-2": "Street address for this dispensary.", "11-0": "address.address2", "11-1": "`string`", "11-2": "Additional street address line for this dispensary.", "12-0": "address.zip", "12-1": "`string`", "12-2": "Zip Code for this dispensary." }, "cols": 3, "rows": 31 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Grass Roots\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots\",\n \"qr\": \"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/grass-roots/qr-code\",\n \"url\": \"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/grass-roots\",\n \"image\": \"https://www.cannabisreports.com/images/profile/5/full_5720f041410b18488b6e4b92c0a3ce598bec3ea8.jpg\",\n \"state\": \"CA\",\n \"city\": \"San Francisco\",\n \"slug\": \"ca/san-francisco/grass-roots\",\n \"lat\": \"37.7866941\",\n \"lng\": \"-122.4194293\",\n \"address\": {\n \"address1\": \"1077 Post Street\",\n \"address2\": \"\",\n \"zip\": \"94109\"\n },\n \"reviews\": {\n \"count\": 55,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/reviews\"\n },\n \"strains\": {\n \"count\": 39,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/strains\"\n },\n \"extracts\": {\n \"count\": 59,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/extracts\"\n },\n \"edibles\": {\n \"count\": 167,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/edibles\"\n },\n \"products\": {\n \"count\": 54,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/products\"\n },\n \"createdAt\": {\n \"datetime\": \"2015-04-24 20:13:46\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-04-24 20:13:46\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Dispensary Endpoints" } [/block] Here are some of the results available from the different dispensary endpoints: [block:parameters] { "data": { "0-0": "[/dispensaries](doc:dispensaries)", "0-1": "Gets a paginated list of dispensaries from the system.", "1-0": "[/dispensaries/:state/:city/:slug](doc:dispensaries-state-city-slug)", "1-1": "Gets information about an individual dispensary based on the state, city, and slug.", "2-0": "[/dispensaries/:state/:city/:slug/strains](doc:dispensaries-state-city-slug-strains)", "2-1": "Gets a paginated list of strains for a dispensary from the given information.", "3-0": "[/dispensaries/:state/:city/:slug/extracts](doc:dispensaries-state-city-slug-extracts)", "3-1": "Gets a paginated list of extracts for a dispensary from the given information.", "4-0": "[/dispensaries/:state/:city/:slug/edibles](doc:dispensaries-state-city-slug-edibles)", "4-1": "Gets a paginated list of edibles for a dispensary from the given information.", "5-0": "[/dispensaries/:state/:city/:slug/products](doc:dispensaries-state-city-slug-products)", "5-1": "Gets a paginated list of products for a dispensary from the given information." }, "cols": 2, "rows": 6 } [/block]
Cannabis Reports currently refers to all types of retailers in the API as a dispensary. Delivery services will not have an address associated with them, only a location. The dispensary menus are split into [strains](doc:strain-object), [extracts](doc:extract-object), [edibles](doc:edible-object), and [products](doc:product-object). [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the dispensary.", "1-0": "link", "1-1": "`url`", "1-2": "Link to the dispensary in the Cannabis Reports API.", "2-0": "qr", "2-1": "`url`", "2-2": "Link to the QR code for this dispensary.", "3-0": "url", "3-1": "`url`", "3-2": "Link to the dispensary listing on the Cannabis Reports website.", "4-0": "image", "4-1": "`url`", "4-2": "Link to the full size logo image for this dispensary.", "15-0": "reviews.count", "15-1": "`integer`", "15-2": "The number of reviews for items from this dispensary.", "21-0": "extracts.count", "21-1": "`integer`", "21-2": "The number of [extracts](doc:extract-object) available at this dispensary.", "22-0": "extracts.link", "22-1": "`url`", "22-2": "Link to [extracts](doc:extract-object) menu items available from this dispensary.", "27-0": "products.count", "27-1": "`integer`", "27-2": "The number of [products](doc:product-object) available at this dispensary.", "14-0": "reviews", "14-1": "`object`", "14-2": "Object containing information about reviews for this dispensary.", "17-0": "strains", "17-1": "`object`", "17-2": "Object containing information about [strains](doc:strain-object) available at this dispensary.", "16-0": "reviews.link", "16-1": "`url`", "16-2": "Link to the reviews for this dispensary in the Cannabis Reports API.", "18-0": "strains.count", "18-1": "`integer`", "18-2": "The number of [flowers](doc:strain-object) available from the dispensary.", "19-0": "strains.link", "19-1": "`url`", "19-2": "Link to [flower](doc:strain-object) menu items available from this dispensary.", "20-0": "extracts", "20-1": "`object`", "20-2": "Object containing information about [extracts](doc:extract-object) available at this dispensary.", "23-0": "edibles", "23-1": "`object`", "23-2": "Object containing information about [edibles](doc:edible-object) available at this dispensary.", "24-0": "edibles.count", "24-1": "`integer`", "24-2": "Number of [edibles](doc:edible-object) available at this dispensary.", "25-0": "edibles.link", "25-1": "`url`", "25-2": "Link to [edible](doc:edible-object) menu items available from this dispensary.", "26-0": "products", "26-1": "`object`", "26-2": "Object containing information about [products](doc:product-object) available at this dispensary.", "28-0": "products.link", "28-1": "`url`", "28-2": "Link to [product](doc:product-object) menu items available from this dispensary.", "29-0": "updatedAt", "29-1": "`object`", "29-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was updated.", "30-0": "createdAt", "30-1": "`object`", "30-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was added.", "5-0": "state", "5-1": "`string`", "5-2": "Two character representation of the state this dispensary is in.", "6-0": "city", "6-1": "`string`", "6-2": "City this dispensary is in.", "13-0": "slug", "13-1": "`string`", "13-2": "Identifier for this dispensary; a combination of city and state.", "7-0": "lat", "7-1": "`string`", "7-2": "Latitude of this dispensary.", "8-0": "lng", "8-1": "`string`", "8-2": "Longitude of this dispensary.", "9-0": "address", "9-1": "`object`", "9-2": "Object containing additional location information for this dispensary.", "10-0": "address.address1", "10-1": "`string`", "10-2": "Street address for this dispensary.", "11-0": "address.address2", "11-1": "`string`", "11-2": "Additional street address line for this dispensary.", "12-0": "address.zip", "12-1": "`string`", "12-2": "Zip Code for this dispensary." }, "cols": 3, "rows": 31 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Grass Roots\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots\",\n \"qr\": \"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/grass-roots/qr-code\",\n \"url\": \"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/grass-roots\",\n \"image\": \"https://www.cannabisreports.com/images/profile/5/full_5720f041410b18488b6e4b92c0a3ce598bec3ea8.jpg\",\n \"state\": \"CA\",\n \"city\": \"San Francisco\",\n \"slug\": \"ca/san-francisco/grass-roots\",\n \"lat\": \"37.7866941\",\n \"lng\": \"-122.4194293\",\n \"address\": {\n \"address1\": \"1077 Post Street\",\n \"address2\": \"\",\n \"zip\": \"94109\"\n },\n \"reviews\": {\n \"count\": 55,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/reviews\"\n },\n \"strains\": {\n \"count\": 39,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/strains\"\n },\n \"extracts\": {\n \"count\": 59,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/extracts\"\n },\n \"edibles\": {\n \"count\": 167,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/edibles\"\n },\n \"products\": {\n \"count\": 54,\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/products\"\n },\n \"createdAt\": {\n \"datetime\": \"2015-04-24 20:13:46\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-04-24 20:13:46\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Explore Dispensary Endpoints" } [/block] Here are some of the results available from the different dispensary endpoints: [block:parameters] { "data": { "0-0": "[/dispensaries](doc:dispensaries)", "0-1": "Gets a paginated list of dispensaries from the system.", "1-0": "[/dispensaries/:state/:city/:slug](doc:dispensaries-state-city-slug)", "1-1": "Gets information about an individual dispensary based on the state, city, and slug.", "2-0": "[/dispensaries/:state/:city/:slug/strains](doc:dispensaries-state-city-slug-strains)", "2-1": "Gets a paginated list of strains for a dispensary from the given information.", "3-0": "[/dispensaries/:state/:city/:slug/extracts](doc:dispensaries-state-city-slug-extracts)", "3-1": "Gets a paginated list of extracts for a dispensary from the given information.", "4-0": "[/dispensaries/:state/:city/:slug/edibles](doc:dispensaries-state-city-slug-edibles)", "4-1": "Gets a paginated list of edibles for a dispensary from the given information.", "5-0": "[/dispensaries/:state/:city/:slug/products](doc:dispensaries-state-city-slug-products)", "5-1": "Gets a paginated list of products for a dispensary from the given information." }, "cols": 2, "rows": 6 } [/block]
{"__v":6,"_id":"55492df5ee219b0d0017434c","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"When getting menu items from dispensaries, the API will return an object containing [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object), as well as the pricing information for the item.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Name of the item.\",\n    \"1-0\": \"type\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"Type of item: [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object).\",\n    \"2-0\": \"item\",\n    \"2-1\": \"`object`\",\n    \"2-2\": \"The [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object).\",\n    \"3-0\": \"price\",\n    \"3-1\": \"`string`\",\n    \"3-2\": \"The price for the item. This is `null` for [strains](doc:strain-object) and [extracts](doc:extract-object).\",\n    \"4-0\": \"price_half_gram\",\n    \"4-1\": \"`string`\",\n    \"4-2\": \"Price for one half gram of the item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"10-0\": \"updatedAt\",\n    \"10-1\": \"`object`\",\n    \"10-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the dispensary was updated.\",\n    \"11-0\": \"createdAt\",\n    \"11-1\": \"`object`\",\n    \"11-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the dispensary was added.\",\n    \"5-0\": \"price_gram\",\n    \"5-1\": \"`string`\",\n    \"5-2\": \"Price for one gram of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"6-0\": \"price_eighth\",\n    \"6-1\": \"`string`\",\n    \"6-2\": \"Price for one eighth ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"7-0\": \"price_quarter\",\n    \"7-1\": \"`string`\",\n    \"7-2\": \"Price for one quarter ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"8-0\": \"price_half_ounce\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"Price for one half ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"9-0\": \"price_ounce\",\n    \"9-1\": \"`string`\",\n    \"9-2\": \"Price for one ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"Platinum Jack\\\",\\n    \\\"type\\\": \\\"strain\\\",\\n    \\\"item\\\": {\\n        \\\"name\\\": \\\"Platinum Jack\\\",\\n        \\\"ucpc\\\": \\\"9XVU7QLZXL000000000000000\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/9XVU7QLZXL000000000000000\\\",\\n        \\\"qr\\\": \\\"https://www.cannabisreports.com/strain-reports/unknown-breeder/platinum-jack/qr-code.svg\\\",\\n        \\\"url\\\": \\\"https://www.cannabisreports.com/strain-reports/unknown-breeder/platinum-jack\\\",\\n        \\\"image\\\": \\\"https://www.cannabisreports.com/images/strains/9/full_9bc6e872a6785282e6f35def8301326e574c991c.jpg\\\",\\n        \\\"user\\\": \\\"SunnyDee\\\",\\n        \\\"seedCompany\\\": {\\n            \\\"name\\\": \\\"Unknown Breeder\\\",\\n            \\\"ucpc\\\": \\\"9XVU700000000000000000000\\\"\\n        },\\n        \\\"genetics\\\": {\\n            \\\"names\\\": \\\"Jack Herer\\\",\\n            \\\"ucpc\\\": \\\"VUJCJ4TYMG000000000000000\\\"\\n        },\\n        \\\"lineage\\\": {\\n            \\\"Afghanistan\\\": \\\"AF\\\",\\n            \\\"Colombia\\\": \\\"CO\\\",\\n            \\\"India\\\": \\\"IN\\\",\\n            \\\"Mexico\\\": \\\"MX\\\",\\n            \\\"Thailand\\\": \\\"TH\\\"\\n        },\\n        \\\"children\\\": 1,\\n        \\\"reviews\\\": 3,\\n        \\\"createdAt\\\": {\\n            \\\"datetime\\\": \\\"2014-05-16 15:15:47\\\",\\n            \\\"timezone\\\": \\\"UTC\\\"\\n        },\\n        \\\"updatedAt\\\": {\\n            \\\"datetime\\\": \\\"2014-06-15 18:57:14\\\",\\n            \\\"timezone\\\": \\\"UTC\\\"\\n        }\\n    },\\n    \\\"price\\\": null,\\n    \\\"price_half_gram\\\": null,\\n    \\\"price_gram\\\": \\\"17.00\\\",\\n    \\\"price_eighth\\\": \\\"50.00\\\",\\n    \\\"price_quarter\\\": \\\"90.00\\\",\\n    \\\"price_half_ounce\\\": \\\"175.00\\\",\\n    \\\"price_ounce\\\": \\\"320.00\\\",\\n    \\\"createdAt\\\": {\\n        \\\"datetime\\\": \\\"2015-03-11 19:05:15\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    },\\n    \\\"updatedAt\\\": {\\n        \\\"datetime\\\": \\\"2015-04-29 20:48:06\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5546778b3dca710d004647a2","createdAt":"2015-05-05T20:54:13.630Z","excerpt":"Menu items for dispensaries.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"55232972e2de0a3500f0a2df","slug":"menu-item-object","sync_unique":"","title":"Menu Item Object","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Menu Item Object

Menu items for dispensaries.

When getting menu items from dispensaries, the API will return an object containing [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object), as well as the pricing information for the item. [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the item.", "1-0": "type", "1-1": "`string`", "1-2": "Type of item: [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object).", "2-0": "item", "2-1": "`object`", "2-2": "The [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object).", "3-0": "price", "3-1": "`string`", "3-2": "The price for the item. This is `null` for [strains](doc:strain-object) and [extracts](doc:extract-object).", "4-0": "price_half_gram", "4-1": "`string`", "4-2": "Price for one half gram of the item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "10-0": "updatedAt", "10-1": "`object`", "10-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was updated.", "11-0": "createdAt", "11-1": "`object`", "11-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was added.", "5-0": "price_gram", "5-1": "`string`", "5-2": "Price for one gram of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "6-0": "price_eighth", "6-1": "`string`", "6-2": "Price for one eighth ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "7-0": "price_quarter", "7-1": "`string`", "7-2": "Price for one quarter ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "8-0": "price_half_ounce", "8-1": "`string`", "8-2": "Price for one half ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "9-0": "price_ounce", "9-1": "`string`", "9-2": "Price for one ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object)." }, "cols": 3, "rows": 12 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Platinum Jack\",\n \"type\": \"strain\",\n \"item\": {\n \"name\": \"Platinum Jack\",\n \"ucpc\": \"9XVU7QLZXL000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7QLZXL000000000000000\",\n \"qr\": \"https://www.cannabisreports.com/strain-reports/unknown-breeder/platinum-jack/qr-code.svg\",\n \"url\": \"https://www.cannabisreports.com/strain-reports/unknown-breeder/platinum-jack\",\n \"image\": \"https://www.cannabisreports.com/images/strains/9/full_9bc6e872a6785282e6f35def8301326e574c991c.jpg\",\n \"user\": \"SunnyDee\",\n \"seedCompany\": {\n \"name\": \"Unknown Breeder\",\n \"ucpc\": \"9XVU700000000000000000000\"\n },\n \"genetics\": {\n \"names\": \"Jack Herer\",\n \"ucpc\": \"VUJCJ4TYMG000000000000000\"\n },\n \"lineage\": {\n \"Afghanistan\": \"AF\",\n \"Colombia\": \"CO\",\n \"India\": \"IN\",\n \"Mexico\": \"MX\",\n \"Thailand\": \"TH\"\n },\n \"children\": 1,\n \"reviews\": 3,\n \"createdAt\": {\n \"datetime\": \"2014-05-16 15:15:47\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2014-06-15 18:57:14\",\n \"timezone\": \"UTC\"\n }\n },\n \"price\": null,\n \"price_half_gram\": null,\n \"price_gram\": \"17.00\",\n \"price_eighth\": \"50.00\",\n \"price_quarter\": \"90.00\",\n \"price_half_ounce\": \"175.00\",\n \"price_ounce\": \"320.00\",\n \"createdAt\": {\n \"datetime\": \"2015-03-11 19:05:15\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-04-29 20:48:06\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block]
When getting menu items from dispensaries, the API will return an object containing [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object), as well as the pricing information for the item. [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the item.", "1-0": "type", "1-1": "`string`", "1-2": "Type of item: [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object).", "2-0": "item", "2-1": "`object`", "2-2": "The [strain](doc:strain-object), [extract](doc:extract-object), [edible](doc:edible-object), or [product](doc:product-object).", "3-0": "price", "3-1": "`string`", "3-2": "The price for the item. This is `null` for [strains](doc:strain-object) and [extracts](doc:extract-object).", "4-0": "price_half_gram", "4-1": "`string`", "4-2": "Price for one half gram of the item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "10-0": "updatedAt", "10-1": "`object`", "10-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was updated.", "11-0": "createdAt", "11-1": "`object`", "11-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was added.", "5-0": "price_gram", "5-1": "`string`", "5-2": "Price for one gram of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "6-0": "price_eighth", "6-1": "`string`", "6-2": "Price for one eighth ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "7-0": "price_quarter", "7-1": "`string`", "7-2": "Price for one quarter ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "8-0": "price_half_ounce", "8-1": "`string`", "8-2": "Price for one half ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "9-0": "price_ounce", "9-1": "`string`", "9-2": "Price for one ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object)." }, "cols": 3, "rows": 12 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Platinum Jack\",\n \"type\": \"strain\",\n \"item\": {\n \"name\": \"Platinum Jack\",\n \"ucpc\": \"9XVU7QLZXL000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU7QLZXL000000000000000\",\n \"qr\": \"https://www.cannabisreports.com/strain-reports/unknown-breeder/platinum-jack/qr-code.svg\",\n \"url\": \"https://www.cannabisreports.com/strain-reports/unknown-breeder/platinum-jack\",\n \"image\": \"https://www.cannabisreports.com/images/strains/9/full_9bc6e872a6785282e6f35def8301326e574c991c.jpg\",\n \"user\": \"SunnyDee\",\n \"seedCompany\": {\n \"name\": \"Unknown Breeder\",\n \"ucpc\": \"9XVU700000000000000000000\"\n },\n \"genetics\": {\n \"names\": \"Jack Herer\",\n \"ucpc\": \"VUJCJ4TYMG000000000000000\"\n },\n \"lineage\": {\n \"Afghanistan\": \"AF\",\n \"Colombia\": \"CO\",\n \"India\": \"IN\",\n \"Mexico\": \"MX\",\n \"Thailand\": \"TH\"\n },\n \"children\": 1,\n \"reviews\": 3,\n \"createdAt\": {\n \"datetime\": \"2014-05-16 15:15:47\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2014-06-15 18:57:14\",\n \"timezone\": \"UTC\"\n }\n },\n \"price\": null,\n \"price_half_gram\": null,\n \"price_gram\": \"17.00\",\n \"price_eighth\": \"50.00\",\n \"price_quarter\": \"90.00\",\n \"price_half_ounce\": \"175.00\",\n \"price_ounce\": \"320.00\",\n \"createdAt\": {\n \"datetime\": \"2015-03-11 19:05:15\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2015-04-29 20:48:06\",\n \"timezone\": \"UTC\"\n }\n}", "language": "json" } ], "sidebar": true } [/block]
{"__v":7,"_id":"554a6bd6156a480d00e29256","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"When getting menu item information about an already known item, like in many of our `availability` endpoints, the API will return pricing and location information.\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"`string`\",\n    \"0-2\": \"Name of the item.\",\n    \"1-0\": \"ucpc\",\n    \"1-1\": \"`string`\",\n    \"1-2\": \"[UCPC](doc:ucpc-universal-cannabis-product-code) of the item.\",\n    \"2-0\": \"type\",\n    \"2-1\": \"`string`\",\n    \"2-2\": \"The type of item this is: [strain](doc:strain-object), [extract](doc:extract-object, [edible](doc:edible-object), or [product](doc:product-object).\",\n    \"8-0\": \"price\",\n    \"8-1\": \"`string`\",\n    \"8-2\": \"The price for the item. This is `null` for [strains](doc:strain-object) and [extracts](doc:extract-object).\",\n    \"9-0\": \"price_half_gram\",\n    \"9-1\": \"`string`\",\n    \"9-2\": \"Price for one half gram of the item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"15-0\": \"updatedAt\",\n    \"15-1\": \"`object`\",\n    \"15-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the dispensary was updated.\",\n    \"16-0\": \"createdAt\",\n    \"16-1\": \"`object`\",\n    \"16-2\": \"Object containing two strings, \\\"dateTime\\\" and the \\\"timezone\\\" when the dispensary was added.\",\n    \"10-0\": \"price_gram\",\n    \"10-1\": \"`string`\",\n    \"10-2\": \"Price for one gram of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"11-0\": \"price_eighth\",\n    \"11-1\": \"`string`\",\n    \"11-2\": \"Price for one eighth ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"12-0\": \"price_quarter\",\n    \"12-1\": \"`string`\",\n    \"12-2\": \"Price for one quarter ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"13-0\": \"price_half_ounce\",\n    \"13-1\": \"`string`\",\n    \"13-2\": \"Price for one half ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"14-0\": \"price_ounce\",\n    \"14-1\": \"`string`\",\n    \"14-2\": \"Price for one ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).\",\n    \"3-0\": \"location\",\n    \"3-1\": \"`object`\",\n    \"3-2\": \"Object containing information about the location this item is at.\",\n    \"4-0\": \"location.name\",\n    \"4-1\": \"`string`\",\n    \"4-2\": \"Name of the location this item is at.\",\n    \"5-0\": \"location.link\",\n    \"5-1\": \"`url`\",\n    \"5-2\": \"Link to this dispensary in the Cannabis Reports API.\",\n    \"6-0\": \"location.lat\",\n    \"6-1\": \"`string`\",\n    \"6-2\": \"Latitude of the dispensary this item is at.\",\n    \"7-0\": \"location.lng\",\n    \"7-1\": \"`string`\",\n    \"7-2\": \"Longitude of the dispensary this item is at.\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"Jack Herer\\\",\\n    \\\"ucpc\\\": \\\"VUJCJ4TYMG000000000000000\\\",\\n    \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\\\",\\n    \\\"type\\\": \\\"strain\\\",\\n    \\\"location\\\": {\\n        \\\"name\\\": \\\"CBCB\\\",\\n        \\\"link\\\": \\\"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/berkeley/cbcb\\\",\\n        \\\"lat\\\": \\\"37.8540451\\\",\\n        \\\"lng\\\": \\\"-122.2660383\\\"\\n    },\\n    \\\"price\\\": null,\\n    \\\"price_half_gram\\\": null,\\n    \\\"price_gram\\\": \\\"18.00\\\",\\n    \\\"price_eighth\\\": \\\"55.00\\\",\\n    \\\"price_quarter\\\": \\\"105.00\\\",\\n    \\\"price_half_ounce\\\": \\\"195.00\\\",\\n    \\\"price_ounce\\\": \\\"360.00\\\",\\n    \\\"createdAt\\\": {\\n        \\\"datetime\\\": \\\"2014-05-21 02:20:53\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    },\\n    \\\"updatedAt\\\": {\\n        \\\"datetime\\\": \\\"2014-05-21 02:26:19\\\",\\n        \\\"timezone\\\": \\\"UTC\\\"\\n    }\\n}\\n\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"5546778b3dca710d004647a2","createdAt":"2015-05-06T19:30:30.314Z","excerpt":"Menu item summary for when it is known what the menu item is.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"55232972e2de0a3500f0a2df","slug":"menu-item-summary-object","sync_unique":"","title":"Menu Item Summary Object","type":"basic","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

Menu Item Summary Object

Menu item summary for when it is known what the menu item is.

When getting menu item information about an already known item, like in many of our `availability` endpoints, the API will return pricing and location information. [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the item.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the item.", "2-0": "type", "2-1": "`string`", "2-2": "The type of item this is: [strain](doc:strain-object), [extract](doc:extract-object, [edible](doc:edible-object), or [product](doc:product-object).", "8-0": "price", "8-1": "`string`", "8-2": "The price for the item. This is `null` for [strains](doc:strain-object) and [extracts](doc:extract-object).", "9-0": "price_half_gram", "9-1": "`string`", "9-2": "Price for one half gram of the item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "15-0": "updatedAt", "15-1": "`object`", "15-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was updated.", "16-0": "createdAt", "16-1": "`object`", "16-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was added.", "10-0": "price_gram", "10-1": "`string`", "10-2": "Price for one gram of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "11-0": "price_eighth", "11-1": "`string`", "11-2": "Price for one eighth ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "12-0": "price_quarter", "12-1": "`string`", "12-2": "Price for one quarter ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "13-0": "price_half_ounce", "13-1": "`string`", "13-2": "Price for one half ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "14-0": "price_ounce", "14-1": "`string`", "14-2": "Price for one ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "3-0": "location", "3-1": "`object`", "3-2": "Object containing information about the location this item is at.", "4-0": "location.name", "4-1": "`string`", "4-2": "Name of the location this item is at.", "5-0": "location.link", "5-1": "`url`", "5-2": "Link to this dispensary in the Cannabis Reports API.", "6-0": "location.lat", "6-1": "`string`", "6-2": "Latitude of the dispensary this item is at.", "7-0": "location.lng", "7-1": "`string`", "7-2": "Longitude of the dispensary this item is at." }, "cols": 3, "rows": 17 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Jack Herer\",\n \"ucpc\": \"VUJCJ4TYMG000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\",\n \"type\": \"strain\",\n \"location\": {\n \"name\": \"CBCB\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/berkeley/cbcb\",\n \"lat\": \"37.8540451\",\n \"lng\": \"-122.2660383\"\n },\n \"price\": null,\n \"price_half_gram\": null,\n \"price_gram\": \"18.00\",\n \"price_eighth\": \"55.00\",\n \"price_quarter\": \"105.00\",\n \"price_half_ounce\": \"195.00\",\n \"price_ounce\": \"360.00\",\n \"createdAt\": {\n \"datetime\": \"2014-05-21 02:20:53\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2014-05-21 02:26:19\",\n \"timezone\": \"UTC\"\n }\n}\n", "language": "json" } ], "sidebar": true } [/block]
When getting menu item information about an already known item, like in many of our `availability` endpoints, the API will return pricing and location information. [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "`string`", "0-2": "Name of the item.", "1-0": "ucpc", "1-1": "`string`", "1-2": "[UCPC](doc:ucpc-universal-cannabis-product-code) of the item.", "2-0": "type", "2-1": "`string`", "2-2": "The type of item this is: [strain](doc:strain-object), [extract](doc:extract-object, [edible](doc:edible-object), or [product](doc:product-object).", "8-0": "price", "8-1": "`string`", "8-2": "The price for the item. This is `null` for [strains](doc:strain-object) and [extracts](doc:extract-object).", "9-0": "price_half_gram", "9-1": "`string`", "9-2": "Price for one half gram of the item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "15-0": "updatedAt", "15-1": "`object`", "15-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was updated.", "16-0": "createdAt", "16-1": "`object`", "16-2": "Object containing two strings, \"dateTime\" and the \"timezone\" when the dispensary was added.", "10-0": "price_gram", "10-1": "`string`", "10-2": "Price for one gram of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "11-0": "price_eighth", "11-1": "`string`", "11-2": "Price for one eighth ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "12-0": "price_quarter", "12-1": "`string`", "12-2": "Price for one quarter ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "13-0": "price_half_ounce", "13-1": "`string`", "13-2": "Price for one half ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "14-0": "price_ounce", "14-1": "`string`", "14-2": "Price for one ounce of this item. This is `null` for [edibles](doc:edible-object) and [products](doc:product-object).", "3-0": "location", "3-1": "`object`", "3-2": "Object containing information about the location this item is at.", "4-0": "location.name", "4-1": "`string`", "4-2": "Name of the location this item is at.", "5-0": "location.link", "5-1": "`url`", "5-2": "Link to this dispensary in the Cannabis Reports API.", "6-0": "location.lat", "6-1": "`string`", "6-2": "Latitude of the dispensary this item is at.", "7-0": "location.lng", "7-1": "`string`", "7-2": "Longitude of the dispensary this item is at." }, "cols": 3, "rows": 17 } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Jack Herer\",\n \"ucpc\": \"VUJCJ4TYMG000000000000000\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VUJCJ4TYMG000000000000000\",\n \"type\": \"strain\",\n \"location\": {\n \"name\": \"CBCB\",\n \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/berkeley/cbcb\",\n \"lat\": \"37.8540451\",\n \"lng\": \"-122.2660383\"\n },\n \"price\": null,\n \"price_half_gram\": null,\n \"price_gram\": \"18.00\",\n \"price_eighth\": \"55.00\",\n \"price_quarter\": \"105.00\",\n \"price_half_ounce\": \"195.00\",\n \"price_ounce\": \"360.00\",\n \"createdAt\": {\n \"datetime\": \"2014-05-21 02:20:53\",\n \"timezone\": \"UTC\"\n },\n \"updatedAt\": {\n \"datetime\": \"2014-05-21 02:26:19\",\n \"timezone\": \"UTC\"\n }\n}\n", "language": "json" } ], "sidebar": true } [/block]
{"__v":0,"_id":"554924e7ee219b0d00174315","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/dispensaries?page=3&sort=-createdAt","name":""}]},"params":[{"_id":"553ebede6ab7691900ee727e","required":false,"desc":"Which page of results you want.","default":"","type":"int","name":"page","in":"query"},{"_id":"553ebede6ab7691900ee727d","required":false,"desc":"How you would like the results sorted.","default":"","type":"string","name":"sort","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"name\": \"The Cookie Co. 415\",\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/the-cookie-co-415\",\n            \"qr\": \"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/the-cookie-co-415/qr-code\",\n            \"url\": \"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/the-cookie-co-415\",\n            \"image\": \"https://www.cannabisreports.com/images/profile/0/full_0bc8bae594a0aba345cad6b559907aa7e4c2a289.jpg\",\n            \"state\": \"CA\",\n            \"city\": \"San Francisco\",\n            \"slug\": \"ca/san-francisco/the-cookie-co-415\",\n            \"lat\": \"37.7470182\",\n            \"lng\": \"-122.418719\",\n            \"address\": {\n                \"address1\": \"3139 Mission Street\",\n                \"address2\": \"\",\n                \"zip\": \"94114\"\n            },\n            \"reviews\": {\n                \"count\": 0,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/the-cookie-co-415/reviews\"\n            },\n            \"strains\": {\n                \"count\": 20,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/the-cookie-co-415/strains\"\n            },\n            \"extracts\": {\n                \"count\": 35,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/the-cookie-co-415/extracts\"\n            },\n            \"edibles\": {\n                \"count\": 42,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/the-cookie-co-415/edibles\"\n            },\n            \"products\": {\n                \"count\": 4,\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/the-cookie-co-415/products\"\n            },\n            \"createdAt\": {\n                \"datetime\": \"2015-04-19 14:22:20\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-04-19 14:22:20\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 70,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 3,\n            \"total_pages\": 7,\n            \"links\": {\n                \"previous\": \"https://www.cannabisreports.com/api/v1.0/dispensaries?sort=-createdAt&page=2\",\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/dispensaries?sort=-createdAt&page=4\"\n            }\n        }\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}","name":""}]},"settings":"","url":"/dispensaries"},"body":"More information about the various fields can be found in the [dispensary object section](doc:dispensary-object) of the documentation.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `dispensaries` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated, created, or alphabetically.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\",\n    \"4-0\": \"name\",\n    \"4-1\": \"Alphabetically stating with numeric producers. 0-9, A-Z.\",\n    \"5-0\": \"-name\",\n    \"5-1\": \"Alphabetically starting with Z and working back through numeric producers. Z-A, 9-0.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","category":"5546778b3dca710d004647a2","createdAt":"2015-05-05T20:15:35.694Z","editedParams":true,"editedParams2":true,"excerpt":"Gets a paginated list of dispensaries from the system.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"55232972e2de0a3500f0a2df","slug":"dispensaries","sync_unique":"","title":"/dispensaries","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/dispensaries

Gets a paginated list of dispensaries from the system.

Query Params

page:
integer
Which page of results you want.
sort:
string
How you would like the results sorted.
More information about the various fields can be found in the [dispensary object section](doc:dispensary-object) of the documentation. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `dispensaries` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated, created, or alphabetically. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records.", "4-0": "name", "4-1": "Alphabetically stating with numeric producers. 0-9, A-Z.", "5-0": "-name", "5-1": "Alphabetically starting with Z and working back through numeric producers. Z-A, 9-0." }, "cols": 2, "rows": 6 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



More information about the various fields can be found in the [dispensary object section](doc:dispensary-object) of the documentation. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `dispensaries` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated, created, or alphabetically. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records.", "4-0": "name", "4-1": "Alphabetically stating with numeric producers. 0-9, A-Z.", "5-0": "-name", "5-1": "Alphabetically starting with Z and working back through numeric producers. Z-A, 9-0." }, "cols": 2, "rows": 6 } [/block]
{"__v":1,"_id":"554926476a82a10d00817a07","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots","name":""}]},"params":[{"_id":"554926476a82a10d00817a0a","default":"ca","desc":"Two character state for the dispensary.","name":"state","required":true,"type":"string","in":"path"},{"_id":"554926476a82a10d00817a09","default":"san-francisco","desc":"City the dispensary is in.","name":"city","required":true,"type":"string","in":"path"},{"_id":"554926476a82a10d00817a08","default":"grass-roots","desc":"Slug for the name of the dispensary.","name":"slug","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"name\": \"Grass Roots\",\n        \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots\",\n        \"qr\": \"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/grass-roots/qr-code\",\n        \"url\": \"https://www.cannabisreports.com/dispensary-reports/ca/san-francisco/grass-roots\",\n        \"image\": \"https://www.cannabisreports.com/images/profile/5/full_5720f041410b18488b6e4b92c0a3ce598bec3ea8.jpg\",\n        \"state\": \"CA\",\n        \"city\": \"San Francisco\",\n        \"slug\": \"ca/san-francisco/grass-roots\",\n        \"lat\": \"37.7866941\",\n        \"lng\": \"-122.4194293\",\n        \"address\": {\n            \"address1\": \"1077 Post Street\",\n            \"address2\": \"\",\n            \"zip\": \"94109\"\n        },\n        \"reviews\": {\n            \"count\": 55,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/reviews\"\n        },\n        \"strains\": {\n            \"count\": 39,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/strains\"\n        },\n        \"extracts\": {\n            \"count\": 58,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/extracts\"\n        },\n        \"edibles\": {\n            \"count\": 167,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/edibles\"\n        },\n        \"products\": {\n            \"count\": 54,\n            \"link\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/products\"\n        },\n        \"createdAt\": {\n            \"datetime\": \"2015-04-24 20:13:46\",\n            \"timezone\": \"UTC\"\n        },\n        \"updatedAt\": {\n            \"datetime\": \"2015-04-24 20:13:46\",\n            \"timezone\": \"UTC\"\n        }\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"Not found. Could not find a dispensary with that information.\",\n    \"status_code\": 404\n}","name":""}]},"settings":"","url":"/dispensaries/:state/:city/:slug"},"body":"More information about the various fields can be found in the [dispensary object](doc:dispensary-object) section of the documentation.","category":"5546778b3dca710d004647a2","createdAt":"2015-05-05T20:21:27.313Z","editedParams":true,"editedParams2":true,"excerpt":"Gets information about an individual dispensary based on the state, city, and slug.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"55232972e2de0a3500f0a2df","slug":"dispensaries-state-city-slug","sync_unique":"","title":"/dispensaries/:state/:city/:slug","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/dispensaries/:state/:city/:slug

Gets information about an individual dispensary based on the state, city, and slug.

Path Params

state:
required
stringca
Two character state for the dispensary.
city:
required
stringsan-francisco
City the dispensary is in.
slug:
required
stringgrass-roots
Slug for the name of the dispensary.
More information about the various fields can be found in the [dispensary object](doc:dispensary-object) section of the documentation.

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



More information about the various fields can be found in the [dispensary object](doc:dispensary-object) section of the documentation.
{"__v":0,"_id":"5549279aee219b0d00174325","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/strains","name":""}]},"params":[{"_id":"5549279aee219b0d00174328","default":"ca","desc":"Two character state where the dispensary is.","name":"state","required":true,"type":"string","in":"path"},{"_id":"5549279aee219b0d00174327","default":"san-francisco","desc":"City where the dispensary is.","name":"city","required":true,"type":"string","in":"path"},{"_id":"5549279aee219b0d00174326","default":"grass-roots","desc":"Slug for the name of the dispensary.","name":"slug","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"OG x Girl Scout Cookies\",\n            \"type\": \"strain\",\n            \"item\": {\n                \"name\": \"OG x Girl Scout Cookies\",\n                \"ucpc\": \"9XVU76RXQ7000000000000000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU76RXQ7000000000000000\",\n                \"qr\": \"https://www.cannabisreports.com/strain-reports/unknown-breeder/og-x-girl-scout-cookies/qr-code.svg\",\n                \"url\": \"https://www.cannabisreports.com/strain-reports/unknown-breeder/og-x-girl-scout-cookies\",\n                \"image\": \"https://www.cannabisreports.com/images/strains/no_image.png\",\n                \"seedCompany\": {\n                    \"name\": \"Unknown Breeder\",\n                    \"ucpc\": \"9XVU700000000000000000000\",\n                    \"link\": \"https://www.cannabisreports.com/api/v1.0/seed-companies/9XVU700000000000000000000\"\n                },\n                \"genetics\": {\n                    \"names\": \"OG Kush (Ogreskush) / Girl Scout Cookies\",\n                    \"ucpc\": \"9XVU7GD2AP000000000000000 / 4KXM32V9YF000000000000000\",\n                    \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU76RXQ7000000000000000/genetics\"\n                },\n                \"lineage\": {\n                    \"Afghanistan\": \"AF\",\n                    \"South Africa\": \"ZA\"\n                },\n                \"children\": {\n                    \"count\": 0,\n                    \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU76RXQ7000000000000000/children\"\n                },\n                \"reviews\": {\n                    \"count\": 0,\n                    \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/9XVU76RXQ7000000000000000/reviews\"\n                },\n                \"createdAt\": {\n                    \"datetime\": \"2014-06-24 01:23:30\",\n                    \"timezone\": \"UTC\"\n                },\n                \"updatedAt\": {\n                    \"datetime\": \"2014-06-24 01:23:31\",\n                    \"timezone\": \"UTC\"\n                }\n            },\n            \"price\": null,\n            \"price_half_gram\": null,\n            \"price_gram\": \"17.00\",\n            \"price_eighth\": \"50.00\",\n            \"price_quarter\": \"90.00\",\n            \"price_half_ounce\": \"175.00\",\n            \"price_ounce\": \"320.00\",\n            \"createdAt\": {\n                \"datetime\": \"2015-04-29 20:44:11\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-04-29 20:44:35\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 39,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 4,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/strains?page=2\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a dispensary with that information.\",\n    \"status_code\": 404\n}","language":"json","status":404},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}"}]},"settings":"","url":"/dispensaries/:state/:city/:slug/strains"},"body":"This will return an array of dispensary menu items with [strains](doc:cannabis-strains) for the items. More information about dispensary menu items can be found in the [menu item object](doc:menu-item-object) section of the documentation.\n\nMore information about the strain fields can be found in the [strain object](doc:strain-object) section of the documentation.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `dispensaries`.`strains` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"5546778b3dca710d004647a2","createdAt":"2015-05-05T20:27:06.361Z","editedParams":true,"editedParams2":true,"excerpt":"Get a paginated list of strains for a dispensary from the given information.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"55232972e2de0a3500f0a2df","slug":"dispensaries-state-city-slug-strains","sync_unique":"","title":"/dispensaries/:state/:city/:slug/strains","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/dispensaries/:state/:city/:slug/strains

Get a paginated list of strains for a dispensary from the given information.

Path Params

state:
required
stringca
Two character state where the dispensary is.
city:
required
stringsan-francisco
City where the dispensary is.
slug:
required
stringgrass-roots
Slug for the name of the dispensary.
This will return an array of dispensary menu items with [strains](doc:cannabis-strains) for the items. More information about dispensary menu items can be found in the [menu item object](doc:menu-item-object) section of the documentation. More information about the strain fields can be found in the [strain object](doc:strain-object) section of the documentation. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `dispensaries`.`strains` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will return an array of dispensary menu items with [strains](doc:cannabis-strains) for the items. More information about dispensary menu items can be found in the [menu item object](doc:menu-item-object) section of the documentation. More information about the strain fields can be found in the [strain object](doc:strain-object) section of the documentation. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `dispensaries`.`strains` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"55493d286a82a10d00817aac","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/extracts","name":""}]},"params":[{"_id":"5549279aee219b0d00174328","default":"ca","desc":"Two character state where the dispensary is.","name":"state","required":true,"type":"string","in":"path"},{"_id":"5549279aee219b0d00174327","default":"san-francisco","desc":"City where the dispensary is.","name":"city","required":true,"type":"string","in":"path"},{"_id":"5549279aee219b0d00174326","default":"grass-roots","desc":"Slug for the name of the dispensary.","name":"slug","required":true,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"name\": \"Bubblegum - Vaporizer Cartridge\",\n            \"type\": \"extract\",\n            \"item\": {\n                \"name\": \"Bubblegum - Vaporizer Cartridge\",\n                \"ucpc\": \"VRTEW9D296P93C7HHCVM00000\",\n                \"link\": \"https://www.cannabisreports.com/api/v1.0/extracts/VRTEW9D296P93C7HHCVM00000\",\n                \"qr\": \"https://www.cannabisreports.com/extract-reports/qr-code/gold-drop/thseeds/bubblegum/vaporizer-cartridge.png\",\n                \"barcode\": \"https://www.cannabisreports.com/extract-reports/barcode/gold-drop/thseeds/bubblegum/vaporizer-cartridge.png\",\n                \"url\": \"https://www.cannabisreports.com/extract-reports/gold-drop/thseeds/bubblegum/vaporizer-cartridge\",\n                \"image\": \"https://www.cannabisreports.com/images/extracts/5/full_5dc14aff95a88e78e77fb4e9e28ff06584b8e174.jpg\",\n                \"producer\": {\n                    \"name\": \"Gold Drop\",\n                    \"ucpc\": \"0000000000P93C70000000000\",\n                    \"link\": \"https://www.cannabisreports.com/api/v1.0/producers/0000000000P93C70000000000\"\n                },\n                \"type\": \"vaporizer cartridge\",\n                \"strain\": {\n                    \"name\": \"Bubblegum\",\n                    \"ucpc\": \"VRTEW9D296000000000000000\",\n                    \"link\": \"https://www.cannabisreports.com/api/v1.0/strains/VRTEW9D296000000000000000\"\n                },\n                \"labTest\": false,\n                \"thc\": false,\n                \"cbd\": false,\n                \"reviews\": 0,\n                \"createdAt\": {\n                    \"datetime\": \"2015-03-10 04:57:00\",\n                    \"timezone\": \"UTC\"\n                },\n                \"updatedAt\": {\n                    \"datetime\": \"2015-03-16 22:52:20\",\n                    \"timezone\": \"UTC\"\n                }\n            },\n            \"price\": null,\n            \"price_half_gram\": \"30.00\",\n            \"price_gram\": \"66.50\",\n            \"price_eighth\": null,\n            \"price_quarter\": null,\n            \"price_half_ounce\": null,\n            \"price_ounce\": null,\n            \"createdAt\": {\n                \"datetime\": \"2015-04-29 21:39:52\",\n                \"timezone\": \"UTC\"\n            },\n            \"updatedAt\": {\n                \"datetime\": \"2015-04-29 21:40:34\",\n                \"timezone\": \"UTC\"\n            }\n        },\n        {...}\n    ],\n    \"meta\": {\n        \"pagination\": {\n            \"total\": 58,\n            \"count\": 10,\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"total_pages\": 6,\n            \"links\": {\n                \"next\": \"https://www.cannabisreports.com/api/v1.0/dispensaries/ca/san-francisco/grass-roots/extracts?page=2\"\n            }\n        }\n    }\n}","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Not found. Could not find a dispensary with that information.\",\n    \"status_code\": 404\n}","language":"json","status":404},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid sort. Please refer to the documentation for appropriate sorts.\",\n    \"status_code\": 400\n}"}]},"settings":"","url":"/dispensaries/:state/:city/:slug/extracts"},"body":"This will return an array of dispensary menu items with [extracts](doc:extract-object) for the items. More information about dispensary menu items can be found in the [menu item object](doc:menu-item-object) section of the documentation.\n\nMore information about the extract fields can be found in the [extract object](doc:extract-object) section of the documentation.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"page\"\n}\n[/block]\nBy default, Cannabis Reports will return 10 records at a time for the `dispensaries`.`extracts` API. You can use the `page` argument to fetch the page of results you want. \n\nCheck out the [pagination](doc:pagination) section of this documentation for further information.\n[block:api-header]\n{\n  \"type\": \"options\",\n  \"title\": \"sort\"\n}\n[/block]\nYou can include a single sort option to get the records by when they were updated or created.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Sort Option\",\n    \"h-1\": \"Sort Direction\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"Oldest records.\",\n    \"1-0\": \"-createdAt\",\n    \"1-1\": \"Newest records.\",\n    \"2-0\": \"updatedAt\",\n    \"2-1\": \"Oldest updated records.\",\n    \"3-0\": \"-updatedAt\",\n    \"3-1\": \"Newly updated records.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"5546778b3dca710d004647a2","createdAt":"2015-05-05T21:59:04.387Z","editedParams":true,"editedParams2":true,"excerpt":"Get a paginated list of extracts for a dispensary from the given information.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"55232972e2de0a3500f0a2df","slug":"dispensaries-state-city-slug-extracts","sync_unique":"","title":"/dispensaries/:state/:city/:slug/extracts","type":"get","updates":[],"user":"55232946b6d1c11700a1292a","version":"55232973e2de0a3500f0a2e2","childrenPages":[]}

get/dispensaries/:state/:city/:slug/extracts

Get a paginated list of extracts for a dispensary from the given information.

Path Params

state:
required
stringca
Two character state where the dispensary is.
city:
required
stringsan-francisco
City where the dispensary is.
slug:
required
stringgrass-roots
Slug for the name of the dispensary.
This will return an array of dispensary menu items with [extracts](doc:extract-object) for the items. More information about dispensary menu items can be found in the [menu item object](doc:menu-item-object) section of the documentation. More information about the extract fields can be found in the [extract object](doc:extract-object) section of the documentation. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `dispensaries`.`extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]

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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will return an array of dispensary menu items with [extracts](doc:extract-object) for the items. More information about dispensary menu items can be found in the [menu item object](doc:menu-item-object) section of the documentation. More information about the extract fields can be found in the [extract object](doc:extract-object) section of the documentation. [block:api-header] { "type": "options", "title": "page" } [/block] By default, Cannabis Reports will return 10 records at a time for the `dispensaries`.`extracts` API. You can use the `page` argument to fetch the page of results you want. Check out the [pagination](doc:pagination) section of this documentation for further information. [block:api-header] { "type": "options", "title": "sort" } [/block] You can include a single sort option to get the records by when they were updated or created. [block:parameters] { "data": { "h-0": "Sort Option", "h-1": "Sort Direction", "0-0": "createdAt", "0-1": "Oldest records.", "1-0": "-createdAt", "1-1": "Newest records.", "2-0": "updatedAt", "2-1": "Oldest updated records.", "3-0": "-updatedAt", "3-1": "Newly updated records." }, "cols": 2, "rows": 4 } [/block]
{"__v":0,"_id":"55493e3eee219b0d0017438d","api":{"auth":"optional","examples":{"codes":[{"language":"text","code":"htt