squash-matrix-api
SquashMatrixApi - JavaScript client for squash-matrix-api
https://squashmatrix.com # API Aside from the documentation provided below, there is also a {json:api}
available and can be accessed in the same manner, with the addition of the accept header {accept: application/vnd.api+json}
. More information about json api can be viewed on their website at http://jsonapi.org/ # Squash Matrix Scrapper There is a ruby SDK for retrieving information from https://squashmatrix.com which can be found at https://rubygems.org/gems/squash_matrix # SDK's Please stay posted! Client sdk's for the following will be provided shortly: - Javascript - Java - Ruby # Blog Find relevent and interesting media on wilkosz.com.au # Contact Join this endeavor and be appart of the community https://www.facebook.com/squashmatrixapi
Endeavor The squash matrix API enables clubs, players, and regions to own their information, with results being updated weekly. The API information sits ontop of squash matrix australia website This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
Node.js
Fornpm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install squash-matrix-api --save
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: rules: parser: amd: false
Getting Started
Please follow the installation instruction and execute the following JS code:
var SquashMatrixApi = ; var api = var opts = 'page': 56 // {Number} The page of clubs 'pageSize': 56 // {Number} The size of page;api;
Documentation for API Endpoints
All URIs are relative to https://api.squashmatrix.io/v1
Class | Method | HTTP request | Description |
---|---|---|---|
SquashMatrixApi.DefaultApi | clubsGet | GET /clubs | Get page of clubs |
SquashMatrixApi.DefaultApi | clubsSquashMatrixIdGet | GET /clubs/{squashMatrixId} | Get club by Squash Matrix ID |
SquashMatrixApi.DefaultApi | gamesGameIdGet | GET /games/{gameId} | Get game by ID |
SquashMatrixApi.DefaultApi | gamesGet | GET /games | Get page of games |
SquashMatrixApi.DefaultApi | playersGet | GET /players | Get page of players |
SquashMatrixApi.DefaultApi | playersSquashMatrixIdGet | GET /players/{squashMatrixId} | Get player by Squash Matrix ID |
Documentation for Models
- SquashMatrixApi.ApiResponseErrors
- SquashMatrixApi.ApiResponseErrorsErrors
- SquashMatrixApi.Club
- SquashMatrixApi.Game
- SquashMatrixApi.InlineResponse200
- SquashMatrixApi.InlineResponse2001
- SquashMatrixApi.InlineResponse2002
- SquashMatrixApi.InlineResponse2003
- SquashMatrixApi.InlineResponse2004
- SquashMatrixApi.InlineResponse2005
- SquashMatrixApi.Player
Documentation for Authorization
All endpoints do not require authorization.