https://github.com/sigeth/codingame-api-node-ts

A Node extension to use the undocumented CodinGame API
https://github.com/sigeth/codingame-api-node-ts

codingame node

Last synced: 7 months ago
JSON representation

A Node extension to use the undocumented CodinGame API

• Host: GitHub
• URL: https://github.com/sigeth/codingame-api-node-ts
• Owner: Sigeth
• License: mit
• Created: 2021-05-28T21:40:57.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-11T15:29:41.000Z (about 3 years ago)
• Last Synced: 2025-04-04T02:41:25.530Z (10 months ago)
• Topics: codingame, node
• Language: TypeScript
• Homepage: https://sigeth.github.io/codingame-api-node-ts
• Size: 413 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CodinGame API undocumented

### Current API knowledge and advancement

To follow how far this package is, you can check the Trello : https://trello.com/b/q5vxDgBO/codingame-endpoints

### Docs

You can see every current functions in the src/lib folder. You can see the types and the keys of the results by checking the interface result.

### Installation

This is a node, so you are supposed to use it with Nodejs.


To import the module, you need to do this in a command prompt :


`npm install codingame-api-node-ts`

### Example

This is the code to login to CodinGame

```js

const { loginCodinGamer } = require('codingame-api-node-ts')

try {

  const email = "api@test.example"

  const password = "apitest"

  const session = await loginCodinGamer(email, password)

  

  console.log(session)

} catch (e) {

  //axios error

  console.log(e)

}

```

You can see the result of this by going to https://github.com/Sigeth/codingame-api-node-ts/blob/main/src/lib/api/auth.ts and check the interface "ILoginCodinGamer", that contains every keys and results of the response.