{"library":"pinterest-api-sdk","title":"Pinterest API SDK","description":"The Pinterest API SDK is a Python library designed to simplify interaction with the Pinterest API v5. It provides functionalities for campaign management, streamlines authentication, and handles error reporting. The SDK is actively developed, with its current version being 0.2.6, and aims to expand its capabilities to cover organic Pins, shopping, analytics, and more over time.","language":"python","status":"active","last_verified":"Mon May 18","install":{"commands":["pip install pinterest-api-sdk"],"cli":null},"imports":["from pinterest.client import PinterestSDKClient","from pinterest.ads.ad_accounts import AdAccount"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import os\nfrom pinterest.client import PinterestSDKClient\nfrom pinterest.ads.ad_accounts import AdAccount\n\n# Set environment variables or create a .env file with PINTEREST_APP_ID, PINTEREST_APP_SECRET,\n# PINTEREST_ACCESS_TOKEN (or PINTEREST_REFRESH_ACCESS_TOKEN if using refresh token flow).\n# Example environment variables:\n# os.environ['PINTEREST_APP_ID'] = 'YOUR_APP_ID'\n# os.environ['PINTEREST_APP_SECRET'] = 'YOUR_APP_SECRET'\n# os.environ['PINTEREST_ACCESS_TOKEN'] = 'YOUR_ACCESS_TOKEN'\n\n# Create a default client (uses environment variables or config.json)\n# For production, consider using create_client_with_refresh_token for long-lived access\ntry:\n    client = PinterestSDKClient.create_default_client()\n    \n    # Example: List ad accounts\n    ad_accounts = AdAccount.get_all(client=client) # Pass client explicitly if not using default behavior\n    \n    if ad_accounts:\n        print(f\"Found {len(ad_accounts)} ad account(s).\")\n        for account in ad_accounts:\n            print(f\"  Ad Account ID: {account.id}, Name: {account.name}\")\n    else:\n        print(\"No ad accounts found or accessible.\")\n\nexcept Exception as e:\n    print(f\"An error occurred: {e}\")\n    print(\"Please ensure your Pinterest API credentials (APP_ID, APP_SECRET, ACCESS_TOKEN) are correctly set as environment variables or in a .env file.\")","lang":"python","description":"This quickstart demonstrates how to initialize the Pinterest SDK client using environment variables and retrieve a list of accessible ad accounts. Ensure your Pinterest App ID, Secret, and an Access Token (or Refresh Token) are configured as environment variables or in a `.env` file for the `create_default_client()` method to function.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-18","installed_version":"0.2.6","pypi_latest":"0.2.6","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":2.9,"avg_import_s":0.68,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.58,"mem_mb":8,"disk_size":"41.8M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":3.1,"import_time_s":0.46,"mem_mb":8,"disk_size":"42M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.87,"mem_mb":9.1,"disk_size":"46.6M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.9,"import_time_s":0.82,"mem_mb":9.1,"disk_size":"47M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.73,"mem_mb":9.4,"disk_size":"38.2M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.7,"import_time_s":0.8,"mem_mb":9.4,"disk_size":"39M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.74,"mem_mb":9.5,"disk_size":"37.8M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.8,"import_time_s":0.76,"mem_mb":9.5,"disk_size":"38M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.56,"mem_mb":7.8,"disk_size":"41.3M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"pinterest-api-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":3.2,"import_time_s":0.52,"mem_mb":7.8,"disk_size":"42M"}]}}