Skip to content

This repository provides the OpenAPI Specification (OAS) of Strike, the Bitcoin platform, as well as the crawler that generates the spec.

Notifications You must be signed in to change notification settings

RndUsername/strike-openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Strike API OpenAPI 3.0 Specification

This repository contains a complete OpenAPI 3.0 specification for the Strike API.

Usage

You can download the latest version of the OpenAPI specification from the release page or use it directly via https://github.com/RndUsername/strike-open-api/releases/download/{version}/strike-openapi.yaml, where {version} is the release version, e.g. v1.0.0.

How is the specification made?

Parts of the specification get crawled from the official documentation, after which it gets assembled and modified to get a complete specification file.

Additional Resources

Contributing

This specification is based on the official Strike API documentation. If you find any discrepancies or have suggestions for improvements, please open an issue or submit a pull request.

Run pnpm install to setup the project and run pnpm run start <version> to create the spec, where <version> is the version that gets written into the spec. Use at least version 24 of Node.js as this is a TypeScript project.

License

This OpenAPI specification is provided for integration purposes. Please refer to Strike's API Terms for usage terms and conditions.

About

This repository provides the OpenAPI Specification (OAS) of Strike, the Bitcoin platform, as well as the crawler that generates the spec.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •