How to Export Asset Metadata from PhotoShelter for Brands

PhotoShelter for Brands REST API

import requests
import csv
import time

ORG_URL = "https://your-org.photoshelter.com"
API_KEY = "your_api_key"
HEADERS = {
    "X-PS-Api-Key": API_KEY,
    "Accept": "application/json",
}

# Authenticate
auth = requests.post(
    f"{ORG_URL}/psapi/v4/mem/authenticate",
    headers=HEADERS,
    json={
        "email": "your_admin_email@company.com",
        "password": "your_password",
    },
)
token = auth.json()["data"]["attributes"]["token"]
HEADERS["X-PS-Auth-Token"] = token

def list_all_assets():
    """List all assets with metadata via pagination."""
    all_assets = []
    page = 1
    per_page = 100
    while True:
        resp = requests.get(
            f"{ORG_URL}/psapi/v4/mem/images",
            headers=HEADERS,
            params={
                "page": page,
                "per_page": per_page,
            },
        )
        data = resp.json()
        assets = data.get("data", [])
        if not assets:
            break
        all_assets.extend(assets)
        page += 1
        if len(assets) < per_page:
            break
        time.sleep(0.5)  # respect rate limits
    return all_assets

assets = list_all_assets()

with open("photoshelter_brands_metadata.csv", "w", newline="") as f:
    writer = csv.writer(f)
    writer.writerow([
        "Asset ID", "Filename", "Title", "Description",
        "Keywords", "Copyright", "Creator",
        "File Type", "File Size", "Width", "Height",
        "Created", "Modified", "Custom Metadata", "AI Tags",
    ])
    for asset in assets:
        attrs = asset.get("attributes", {})
        iptc = attrs.get("iptc", {})
        custom = attrs.get("custom_metadata", {})
        ai = attrs.get("ai_tags", [])
        writer.writerow([
            asset.get("id", ""),
            attrs.get("file_name", ""),
            iptc.get("title", ""),
            iptc.get("caption", ""),
            "; ".join(iptc.get("keywords", [])),
            iptc.get("copyright", ""),
            iptc.get("creator", ""),
            attrs.get("file_type", ""),
            attrs.get("file_size", ""),
            attrs.get("width", ""),
            attrs.get("height", ""),
            attrs.get("created_at", ""),
            attrs.get("updated_at", ""),
            "; ".join(
                f"{k}: {v}" for k, v in custom.items()
            ) if custom else "",
            "; ".join(ai) if ai else "",
        ])

print(f"Exported {len(assets)} assets to photoshelter_brands_metadata.csv")

Admin Download Reports