Example: REST API pagination

Jeff_Beeland · October 18, 2019, 7:03pm

Hey everyone,

We’ve received some questions about how to query data from Shotgun via the REST API when there’s more data being requested than fits into a single “page” returned by the API for a single request.

I’ve written up a short example script in Python in this gist that will hopefully act as a starting point for those of you needing to query large amounts of data from Shotgun.

I hope this helps, and please let us know if there’s anything that’s unclear in the example. I’ll be happy to provide additional information or guidance if anyone needs it!

gist.github.com

https://gist.github.com/thebeeland/e13bcba9d6c378ecaeeba8f1b20f5491

sg_rest_api_pagination_example.py


import requests
import pprint
import json
import os

site_url = os.environ["SHOTGUN_SITE_URL"] # ie: https://foobar.shotgunstudio.com

headers = {
    "Accept": "application/json",

This file has been truncated. show original

Jeff_Beeland · October 25, 2019, 12:03am

We’ve also had a few questions come up about doing the same as above, but for POST calls instead of GET. We’ve adapted the above GET example to work for POST calls – see the below!

gist.github.com

https://gist.github.com/thebeeland/602f1589e134e28410e05832b5b4f157

sg_rest_api_pagination_post_example.py

import requests
import pprint
import json
import os

site_url = os.environ["SHOTGUN_SITE_URL"] # ie: https://foobar.shotgunstudio.com

headers = {
    "Accept": "application/json",
    "Content-Type": "application/x-www-form-urlencoded"

This file has been truncated. show original