Block SDKs & Libraries: Development Tools (2026)

SDKs overview

Block, Inc., through its various products like Square and Cash App, provides a suite of Software Development Kits (SDKs) and libraries designed to facilitate API integration for developers. These SDKs abstract much of the complexity involved in direct API calls, offering language-specific interfaces for common tasks such as processing payments, managing customer data, interacting with point-of-sale systems, and accessing financial data. The primary goal of these tools is to streamline the development process for applications that interact with Block's ecosystem, covering aspects from mobile payments to backend business operations.

Block's developer platform emphasizes comprehensive documentation and developer-friendly tools. The SDKs are maintained by Block's engineering teams and are typically available as open-source projects on platforms like GitHub, allowing for community contributions and transparency. This approach enables developers to build custom applications that leverage Block's infrastructure for various use cases, ranging from e-commerce platforms to specialized business management tools. For detailed information on the available APIs and their functionalities, developers can refer to the official Square developer documentation.

Official SDKs by language

Block provides official SDKs for several popular programming languages, each designed to offer idiomatic access to the various Square APIs. These SDKs are actively maintained and updated to reflect changes and new features in the API platform. The following table provides an overview of the officially supported SDKs, their typical package names, and common installation methods.

Each SDK is typically generated from the OpenAPI specification of Block's APIs, ensuring consistency and up-to-date functionality across different language implementations. Developers are encouraged to consult the specific SDK's documentation within the Square developer portal for detailed usage instructions, API method references, and example code pertinent to their chosen language.

Installation

Installing Block's SDKs generally follows standard package management practices for each respective programming language. Below are detailed installation steps for the most commonly used SDKs:

JavaScript (Node.js and Browser Environments)

For Node.js projects, use npm or Yarn:

npm install square
# or
yarn add square

The JavaScript SDK supports both Node.js server-side operations and client-side browser usage, with considerations for secure API key handling. Learn more about the Square Web SDK client-side build in the official documentation.

Python

The Python SDK can be installed using pip, Python's package installer:

pip install square

Ensure you are using a virtual environment for project isolation. After installation, the SDK can be imported and used to interact with Block's APIs. The Square Python SDK setup guide provides further details.

Java

For Java projects, you typically add the SDK as a dependency in your build tool. For Maven, add the following to your pom.xml:

<dependency>
    <groupId>com.squareup</groupId>
    <artifactId>square-java-sdk</artifactId>
    <version>[LATEST_VERSION]</version>
</dependency>

Replace [LATEST_VERSION] with the current stable version, which can be found in the Square Java SDK setup instructions. For Gradle, add to your build.gradle:

implementation 'com.squareup:square-java-sdk:[LATEST_VERSION]'

PHP

PHP projects use Composer for dependency management:

composer require square/square

This command downloads the latest version of the PHP SDK and its dependencies. After installation, you can include Composer's autoloader in your script: require 'vendor/autoload.php';. Refer to the Square PHP SDK documentation for more information.

Ruby

The Ruby SDK is available as a RubyGems package:

gem install square-ruby-sdk

Once installed, you can require the gem in your Ruby application: require 'square'. The Square Ruby SDK setup guide offers additional context.

C# (.NET)

For .NET projects, the C# SDK is distributed as a NuGet package:

dotnet add package Square.Connect

Alternatively, you can install it via the NuGet Package Manager in Visual Studio. Detailed instructions for the Square C# SDK are provided in the Block developer documentation.

Quickstart example

This quickstart example demonstrates how to use the Block Python SDK to retrieve a list of locations associated with a Square account. This requires an access token, which can be generated from the Block Developer Dashboard.

from square.client import Client

# Replace with your actual Square access token
# For production, store this securely (e.g., environment variables)
ACCESS_TOKEN = 'YOUR_ACCESS_TOKEN'

# Initialize the Square client
# Set environment to 'production' for live applications
client = Client(
    access_token=ACCESS_TOKEN,
    environment='sandbox' # Use 'production' for live apps
)

# Call the Locations API to get a list of locations
try:
    result = client.locations.list_locations()

    if result.is_success():
        for location in result.body['locations']:
            print(f"Location ID: {location['id']}, Name: {location['name']}, Status: {location['status']}")
    elif result.is_error():
        print(f"API Error: {result.errors}")

except Exception as e:
    print(f"An unexpected error occurred: {e}")

This example initializes the client with a sandbox environment access token. For production applications, ensure the environment is set to 'production' and that the access token is handled securely, preferably through environment variables or a secrets management service, rather than hardcoding it directly in the source code. Additional API calls, such as processing payments or managing catalog items, follow a similar pattern of initializing the client and invoking the relevant service methods. A comprehensive guide for making Square API calls is available in their developer documentation.

Community libraries

While Block maintains a robust set of official SDKs, the developer community often creates and maintains additional libraries and tools that extend or complement Block's offerings. These community-driven projects can range from framework-specific integrations (e.g., for Django, Ruby on Rails, or specific front-end frameworks) to utilities that simplify complex workflows or add features not directly covered by official SDKs.

Community libraries are typically found on package repositories like npm, PyPI, Maven Central, RubyGems, or GitHub. Developers exploring these options should consider factors such as:

• Maintenance Status: How actively is the library maintained? Are there recent commits and updates?
• Documentation: Is the library well-documented with clear usage examples?
• Community Support: Is there an active community (e.g., GitHub issues, forums) for assistance?
• License: What open-source license is the library distributed under?
• Compatibility: Is the library compatible with the latest versions of Block's APIs and your chosen programming language/framework?

Examples of community contributions might include specific UI components for payment forms, advanced webhook handlers, or integrations with third-party analytics tools that leverage Block's data. While official SDKs provide the most reliable and supported path for integration, community libraries can offer specialized solutions for niche requirements. Developers should exercise due diligence when incorporating third-party code into their projects, as these libraries may not carry the same level of support or security guarantees as official Block SDKs. For guidance on secure development practices, general recommendations from organizations such as the World Wide Web Consortium (W3C) on web security are relevant.