Ruby SDK

Start developing with Square in a matter of minutes. The Square Ruby library supports Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality.

You have the following options to explore the Square Ruby SDK.

Link to section

Minimal instructions

If you want minimal instructions:

• Get the SDK package from RubyGems.

• Read the SDK reference library documentation on GitHub.

• Try sample code. For example, the Quickstart provides ListLocations sample code.

Link to section

Detailed instructions

If you prefer detailed instructions, see the following topics:

• Square Ruby SDK Quickstart

• Set up your Square SDK for a Ruby Project

• Using the Square Ruby SDK

• Common Square API Patterns

• Stay Current with the Ruby SDK Version

Link to section

Additional resources

• Release Notes. Learn more about the latest SDK feature releases.

• Forums. Connect with other developers in one of the Square forums.

• Contact Square Developer Support. Submit a form for email support.

• Video: Sandbox Short - Ruby SDK for Square APIs

• Square SDKs. Check out other Square SDKs.