Skip to main content

Folders

Walk the folder tree and bulk-download imagery.

Module method​

sdk.folder.get(folder_id) returns a FolderResource with id, name, parent_folder_id, image_ids, and folder_ids.

The resource lazily exposes:

  • images: images directly in the folder
  • subfolders: direct child folders
  • recursive_images: images in the folder and all descendants

download(folder_path, recursive=True) creates a directory named after the resource and downloads its imagery. Set recursive=False to download only the images directly in that folder.

Example​

folder = sdk.folder.get(folder_id=19)

for image in folder.images:
    print(image.id, image.name)

print("Images in this tree:", len(folder.recursive_images))
folder.download(folder_path="/local/downloads", recursive=True)