Learn how to access locations using the API and write your own location plugins. Before you write your own location plugin, take some time and read the usage guide for locations to make sure you have a good understanding of what they are and what they can do for you.


If you are just looking to get started with ftrack and to track your files, consider using the storage scenario instead.

Before setting up your own location plugin it is important to consider who will be using the location plugin and from where. Location plugins are different depending on what client you will be using and they are not compatible with each other. Location plugins written for the python client are not compatible with the python (legacy) client and vice versa. If you are building your own tools it is recommended that you build your location plugins using the python client. But if you will be using any of the following tools you would have to implement a location plugins using the python (legacy) client:

Eventually all these tools will be converted to use the python client and no longer require you to write location plugins for both clients.


If you configure a location using the storage scenario a location plugin will be automatically configured for both clients python and python (legacy).

You can read more about the implementation of location plugins here: