Socket
Book a DemoInstallSign in
Socket

@spotto/contract

Package Overview
Dependencies
Maintainers
11
Versions
156
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@spotto/contract

Spotto's API Contract type definitions

1.0.61-alpha.2
latest
npmnpm
Version published
Weekly downloads
843
276.34%
Maintainers
11
Weekly downloads
 
Created
Source

README

This repository is a source of truth / documentation for the spotto-api.

The repository consists of a series of typescript classes that document the API contract between the spotto API and its clients

How do I get set up?

  • Clone this repository
  • yarn install
  • run 'yarn start' to start a documentation server

Contribution guidelines

When adding endpoints create a new folder / file for your endpoint. Fill out file using others as a guide.

Any response and request shapes should be specified in the /types folder. The documentation server is sometimes unable to understand more complicated interfaces. In these scenarios please create two types files, one with a logical working type that can be used by other repositories. The other will be simply for filling the response server.

Any documentation specific types files should have the suffix 'Docs' within the same folder. e.g.

  • types
    • objects
      • objectTypes.ts
      • objectTypesDocs.ts

Who do I talk to?

  • Repo owner or admin

FAQs

Package last updated on 04 Sep 2025

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.