TSAPI|Documentation
Back to Home

Frequently Asked Questions

Common questions about TSAPI, its purpose, and implementation.

General Questions

What is TSAPI?

TSAPI is the API Standard for Transferring Survey Data. It's a non-profit initiative to define, distribute, and maintain an API standard for the survey industry. The standard provides a common way for different survey platforms and systems to exchange data.

What is an API Standard?

An API (Application Programming Interface) is a way for computer programs to communicate with each other. A standard is a documented specification that describes how to build or use such a connection. TSAPI provides this standard specifically for survey data.

Why do we need TSAPI?

Without a common standard, each survey platform has its own API definition. When Platform A needs to communicate with Platform B, developers must build custom "converters." With many platforms in the market, this leads to:

  • Significant development time and cost
  • Ongoing maintenance burden
  • Barriers to innovation and new market entrants
  • Fragmentation that stifles the industry

TSAPI solves this by providing a single, agreed-upon standard that all platforms can implement.

Is TSAPI free to use?

Yes! All TSAPI material is licensed under the Creative Commons Attribution 4.0 International License. It is, and always will be, free to all, forever. You simply need to reference and credit the TSAPI Initiative and implement the standard correctly.

Who maintains TSAPI?

The TSAPI Steering Group are all volunteers who guide the initiative with support from interested organisations and individuals. Key contributors include Matt Gibbs (Chair), Tim Brandwood (Lead Programmer), and Jérome Sopoçko (Software Coordinator).

Technical Questions

What format does TSAPI use?

TSAPI represents survey data and metadata in JSON (JavaScript Object Notation). JSON is an open standard data interchange format that uses human-readable text and is widely supported across all programming languages.

Is TSAPI the same as Triple-S?

No. Triple-S is a file format standard for transferring survey data, developed decades ago. TSAPI is an API standard. While TSAPI draws on the experience and best practices from Triple-S (and credits the Triple-S team), it is a distinct, API-based approach suited for modern software architecture.

Does TSAPI support write operations?

Currently, TSAPI Core defines GET methods for reading survey data. The initiative is consulting on extending TSAPI to incorporate POST, PUT, and DELETE methods for write operations. These would be an optional extension to the core standard.

What authentication does TSAPI use?

TSAPI does not prescribe a specific authentication method. Authentication and authorization are determined by the host system implementing TSAPI. This flexibility allows TSAPI to work with various security models.

Can I use TSAPI alongside our existing API?

Platforms can support multiple API definitions, just like they support multiple file export formats (CSV, SAV, Triple-S, etc.). You can add TSAPI as an additional connection option for users without replacing your existing API.

Implementation Questions

How do I implement TSAPI?

TSAPI is an API definition, not software. To implement it:

  1. Review the Swagger documentation
  2. Implement the three GET endpoints in your platform
  3. Ensure your responses match the TSAPI JSON structure
  4. Test against the Postman collection

Is there a reference implementation?

Yes, there are several resources:

Are there Python or JavaScript libraries?

Arrowstream Analytics has released an open-source Python package called "tsapiness" that converts survey data to TSAPI format. Check their GitHub for more details.

Which platforms support TSAPI?

Several organizations have implemented TSAPI in their products, including:

  • Digital Taxonomy - CodeIt (AI-powered unstructured data tagging)
  • Red Centre Software - Carbon Libraries and Diamond
  • Askia - Survey automation suite
  • Arrowstream Analytics - tsapiness Python package

Organization Questions

Is TSAPI part of the ASC?

No, TSAPI is independent of the Association for Survey Computing (ASC). However, the ASC has endorsed TSAPI as an industry standard for survey data transfer and continues to engage with the TSAPI group on an ongoing basis.

How can I support TSAPI?

You can support the initiative by:

  • Implementing TSAPI in your platform
  • Using and promoting the standard
  • Contributing to discussions and feedback
  • Crediting TSAPI when you use it

Can I use the TSAPI logo?

Yes! TSAPI logos are available for use in any setting - websites, software, social media, and print. Using the logo helps raise awareness and shows that your software supports the industry standard. Logo files are available on the TSAPI website.

Will TSAPI ever change?

TSAPI Core is now released to the public domain and will never change. This stability ensures that implementations will continue to work. Optional extensions may be added in the future, but the core specification is fixed.

Where can I learn more?

Have Another Question?

If your question isn't answered here, please reach out through the TSAPI website or the GitHub repository.