t3api 0.6.0
T3 API
Keywords: OpenAPI, OpenAPI-Generator, T3 API

    ## WHAT IS THIS?  This API is part of the [Track &amp; Trace Tools](https://trackandtrace.tools) platform. The API allows you to programmatically access all your Metrc data that is available on metrc.com  It is not related to the Metrc 3rd party API, does not use Metrc API keys, and is not affiliated with Metrc.  If you&#39;re looking for where to get started, check out the [T3 Wiki API Getting Started guide](https://github.com/classvsoftware/t3-wiki/wiki/T3-API-:-Getting-Started).  The T3 API is subject to the [Track &amp; Trace Tools Terms of Use](https://www.trackandtrace.tools/terms-of-use).   ## FREE API ACCESS (LIMITED)  The T3 API features a limited number of free endpoints available to anyone with a Metrc login.  These can be found in the [Free](#/Free) section.  ## FULL API ACCESS  There are two ways to get premium access to the T3 API:  - **Subscribe to [T3+](https://trackandtrace.tools/plus)**  *OR*  - **Use a provided T3 API key (consulting clients only. [Reach out](mailto:matt@trackandtrace.tools) for more information.)**  ## AUTHENTICATION  The T3 API uses JSON Web Tokens (JWT) for request authentication. To obtain a JWT, use one of the following:  - **metrc.com login credentials:**   - **hostname**: (The website you use to login to metrc: &#x60;ca.metrc.com&#x60;, &#x60;or.metrc.com&#x60;, etc.)   - **username**: Your Metrc username   - **password**: Your Metrc password   - **otp**: A one-time password used for 2-factor authentication (Only applies to Michigan users)  *OR*  - **T3 API key**  Refer to the **Authentication** endpoints below for more information.  ## SECRET KEYS  Some endpoints support the use of secret key authentication. This allows you to use simple URLs to access your Metrc data.  ### Usage  Pass the &#x60;secretKey&#x60; returned from the request in the query string:  &#x60;?secretKey&#x3D;&lt;yourSecretKeyGoesHere&gt;&#x60;  ### Generating Secret Keys  Refer to the [/v2/auth/secretkey](#/Authentication/post_v2_auth_secretkey) endpoint for information on generating secret keys.  [Secret Key Generation Tool](/v2/pages/secret-key)  [Sync Link Creation Tool](/v2/pages/sync-link)  ## SECURITY  The T3 API interacts with Metrc in a similar manner to the [Track &amp; Trace Tools](https://chromewebstore.google.com/detail/track-trace-tools/dfljickgkbfaoiifheibjpejloipegcb) Chrome extension. The API login process is designed with a strong emphasis on security. Your Metrc login details are never stored, and the API backend employs robust encryption methods to protect your temporary Metrc session.  ### Key Security Measures:  - **Single-Use Login Credentials:**    - The T3 API uses your login credentials only once to authenticate with Metrc.   - After the Metrc login process is complete, your login credentials are immediately deleted from the system.   - You are required to enter your login credentials each time you access the T3 API, ensuring that your credentials are never stored.    - **Secure Temporary Session Storage:**    - The T3 API securely encrypts your logged-in Metrc session data. This data is only used when you make requests through the T3 API.   - The encrypted session data is automatically deleted after 24 hours, ensuring that your session information is not retained longer than necessary.  For any questions or concerns, please contact [matt@trackandtrace.tools](mailto:matt@trackandtrace.tools).  ## PRIVACY  The T3 API privacy model follows the same principles as the [Track &amp; Trace Tools](https://chromewebstore.google.com/detail/track-trace-tools/dfljickgkbfaoiifheibjpejloipegcb) Chrome extension. The T3 API functions solely as a connector between you and Metrc, ensuring your privacy is protected.  - **No Data Collection:**    - The T3 API does not record, save, harvest, inspect, or analyze any of your data.   - All data interactions are ephemeral and occur in real-time, without permanent storage.  - **Secure and Private Access:**    - Your data is never shared with third parties. Unauthorized access to your login information or data is strictly prohibited.   - T3 employs industry-standard encryption protocols to safeguard all communications between the T3 API and Metrc.    - **User-Controlled Sessions:**    - Your Metrc login credentials and session are used exclusively by you. The T3 API will never initiate Metrc traffic without your explicit authorization.  - **Compliance and Best Practices:**   - T3&#39;s privacy practices are aligned with applicable data protection regulations, including GDPR and CCPA, ensuring that your data rights are respected.  The T3 API is subject to the [Track &amp; Trace Tools Privacy Policy](https://trackandtrace.tools/privacy-policy). For any privacy-related inquiries, please contact [matt@trackandtrace.tools](mailto:matt@trackandtrace.tools).  ## PERMISSIONS  Each Metrc account has different permissions based on several factors:  - Permissions granted by your Metrc admin - Class of license (manufacturing, cultivation, etc) - US state the license operates in  Use the Permissions endpoints to determine which actions are available to you.  ## LICENSES  View a list of all licenses available to the current user:  &#x60;GET https://api.trackandtrace.tools/v2/licenses&#x60;  Only one license can be queried per request. Specify the target license with the required &#x60;licenseNumber&#x60; query parameter:  &#x60;GET https://api.trackandtrace.tools/v2/items?licenseNumber&#x3D;LIC-00001&#x60;  ## RATE LIMITING  The API has a global default request rate limit of 600 requests/minute/user. Some routes have lower rate limits.  ## COLLECTIONS  All data is queried as collections. There are no individual object endpoints.  For example, you cannot find an individual object using an endpoint like &#x60;/plants/{plantId}&#x60;, individual objects must be queried by filtering the collection endpoint &#x60;/plants&#x60; for the exact &#x60;plantId&#x60;.   Collections are paginated, and can be filtered and sorted by individual object fields.  The JSON response object includes the following properties: - &#x60;data&#x60;: An array of objects, or any empty array - &#x60;page&#x60;: The requested page index - &#x60;pageSize&#x60;: The requested page size - &#x60;total&#x60;: The total number of items in this collection. Use this to determine how many pages are required to return the entire collection.  ### COLLECTION PAGINATION  Metrc data collections are queried as pages. Use the &#x60;page&#x60; and &#x60;pageSize&#x60; query parameters to indicate which page should be returned.  By default, &#x60;page&#x3D;1&#x60; and &#x60;pageSize&#x3D;100&#x60;.  Example: Return page 3 with a page size of 500:  &#x60;GET https://api.trackandtrace.tools/v2/items?licenseNumber&#x3D;LIC-00001&amp;page&#x3D;3&amp;pageSize&#x3D;500&#x60;  ### COLLECTION SORTING  Metrc data collections can be sorted. Use the &#x60;sort&#x60; query parameter to indicate how the collection should be sorted.  Example: Sort items by &#x60;name&#x60; descending:  &#x60;GET https://api.trackandtrace.tools/v2/items?licenseNumber&#x3D;LIC-00001&amp;sort&#x3D;name:desc&#x60;  ### COLLECTION FILTERING  Metrc data collections can be filtered. Use one or more &#x60;filter&#x60; query parameters to indicate how filters should be applied.  Example: Filter items that contain \&quot;flower\&quot; in the &#x60;name&#x60; field:  &#x60;GET https://api.trackandtrace.tools/v2/items?licenseNumber&#x3D;LIC-00001&amp;filter:name__contains&#x3D;flower&#x60;  Multiple filters can be applied, and you can specify the logical operator (defaulting to \&quot;and\&quot;):  Example: Filter items that contain \&quot;flower\&quot; in the &#x60;name&#x60; field OR \&quot;kush\&quot; in the &#x60;name&#x60; field:  &#x60;GET https://api.trackandtrace.tools/v2/items?licenseNumber&#x3D;LIC-00001&amp;filter&#x3D;name__contains:flower&amp;filter&#x3D;name__contains:kush&amp;filterLogic&#x3D;or&#x60;  #### FILTERING STRINGS  String fields support the following filter operators:  - &#x60;contains&#x60; - &#x60;doesnotcontain&#x60; - &#x60;eq&#x60; - &#x60;neq&#x60; - &#x60;startswith&#x60; - &#x60;endswith&#x60;  Example &#x60;?filter&#x3D;name__contains:flower&#x60;  **Note: all string filters are case-insensitive**  #### FILTERING DATETIMES  Datetime fields support the following filter operators:  - &#x60;lt&#x60; - &#x60;lte&#x60; - &#x60;eq&#x60; - &#x60;neq&#x60; - &#x60;gt&#x60; - &#x60;gte&#x60;  Example: &#x60;?filter&#x3D;harvestedDate__gte:2024-07-17T20:26:07.117Z&#x60;  **Note: all datetime filters use ISO8601 datetimes**  #### FILTERING BOOLEANS  Boolean fields support the following filter operators:  - &#x60;eq&#x60;  Example: &#x60;?filter&#x3D;finished__eq:true&#x60;  ### LOADING FULL COLLECTIONS &#x60;pageSize&#x60; is limited to 500 in most cases, so you may need to load multiple pages if a license has a large number of packages.  Refer to [this example](https://github.com/classvsoftware/t3-api/blob/master/load_all_active_packages.py) for how to load a full collection in a python script.  ## USING THE API  The API can be used in any way you like, but writing simple scripts to accomplish common tasks is an excellent way to take advantage of it.  The full OpenAPI spec, which can be imported into Postman, can be found here: [/v2/spec/openapi.json](/v2/spec/openapi.json)  [**Lots** of example scripts that show how the use the T3 API can be found here](https://github.com/classvsoftware/t3-api)  ## CONTACT  - **Responsible Organization:** Class V LLC - **Responsible Developer:** Matt Frisbie - **Email:** [matt@trackandtrace.tools](mailto:matt@trackandtrace.tools) - **URL:** [https://trackandtrace.tools](https://trackandtrace.tools) - **Terms of Use:** [https://www.trackandtrace.tools/terms-of-use](https://www.trackandtrace.tools/terms-of-use)