Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.
Use this library to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.
Use of the Python SDK requires:
For more information, see Set Up Your Square SDK for a Python Project.
For more information, see Square Python SDK Quickstart.
For more information, see Using the Square Python SDK.
First, clone the repo locally and cd into the directory.
git clone https://github.com/square/square-python-sdk.git
cd square-python-sdk
Next, install dependencies.
python3 -m pip install .
Before running the tests, find a sandbox token in your Developer Dashboard and set a SQUARE_SANDBOX_TOKEN environment variable.
export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX TOKEN HERE"
Ensure you have pytest installed:
python3 -m pip install pytest
And lastly, run the tests.
pytest
The following Square APIs are deprecated:
Employees - replaced by the Team API. For more information, see Migrate from the Employees API.
Transactions - replaced by the Orders and Payments APIs. For more information, see Migrate from the Transactions API.
FAQs
Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.
We found that squareup demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security Fundamentals
The Socket Threat Research Team uncovers how threat actors weaponize shell techniques across npm, PyPI, and Go ecosystems to maintain persistence and exfiltrate data.
Security News
At VulnCon 2025, NIST scrapped its NVD consortium plans, admitted it can't keep up with CVEs, and outlined automation efforts amid a mounting backlog.
Product
We redesigned our GitHub PR comments to deliver clear, actionable security insights without adding noise to your workflow.