Skip to content

aidant/infra-sight

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Infra Sight

Infra-Sight is an elegant UX focused API for Overwatch.


Table of Contents


Quick Start

npm install @infra-sight/sdk
import * as InfraSight from '@infra-sight/sdk'

const profile = await InfraSight.getOverwatchProfile('Tracer#3939')

console.log(profile)

SDK

getOverwatchAccount

Example

import * as InfraSight from '@infra-sight/sdk'

const account = await InfraSight.getOverwatchAccount()

console.log(account)

Returns Promise<InfraSightAccount>

getOverwatchHeroes

Example

import * as InfraSight from '@infra-sight/sdk'

const heroes = await InfraSight.getOverwatchHeroes()

console.log(heroes)

Returns Promise<OverwatchHeroList>

getOverwatchPlayerIcons

Example

import * as InfraSight from '@infra-sight/sdk'

const icons = await InfraSight.getOverwatchPlayerIcons()

console.log(icons)

Returns Promise<InfraSightPlayerIconRecord>

getOverwatchProfile

Example

import * as InfraSight from '@infra-sight/sdk'

const profile = await InfraSight.getOverwatchProfile()

console.log(profile)

Returns Promise<InfraSightProfile>

searchOverwatchAccounts

Example

import * as InfraSight from '@infra-sight/sdk'

const accounts = await InfraSight.searchOverwatchAccounts()

console.log(accounts)

Returns Promise<InfraSightAccountList>

listOverwatchAccountHistory

Example

import * as InfraSight from '@infra-sight/sdk'

for await (const item of InfraSight.listOverwatchAccountHistory()) {
  console.log(item)
}

Returns AsyncGenerator<string, void, never>

listOverwatchHeroesHistory

Example

import * as InfraSight from '@infra-sight/sdk'

for await (const item of InfraSight.listOverwatchHeroesHistory()) {
  console.log(item)
}

Returns AsyncGenerator<string, void, never>

listOverwatchPlayerIconsHistory

Example

import * as InfraSight from '@infra-sight/sdk'

for await (const item of InfraSight.listOverwatchPlayerIconsHistory()) {
  console.log(item)
}

Returns AsyncGenerator<string, void, never>

listOverwatchProfileHistory

Example

import * as InfraSight from '@infra-sight/sdk'

for await (const item of InfraSight.listOverwatchProfileHistory()) {
  console.log(item)
}

Returns AsyncGenerator<string, void, never>


API

GET /v2/api/overwatch/accounts/{username}/history

Parameters

  • page_token

GET /v2/api/overwatch/accounts/{username}/latest

Parameters

  • platform
  • resolution_strategy

GET /v2/api/overwatch/accounts/{username}/search

GET /v2/api/overwatch/heroes/history

Parameters

  • page_token

GET /v2/api/overwatch/heroes/latest

GET /v2/api/overwatch/player-icons/history

Parameters

  • page_token

GET /v2/api/overwatch/player-icons/latest

GET /v2/api/overwatch/profiles/{username}/history

Parameters

  • page_token

GET /v2/api/overwatch/profiles/{username}/latest

Parameters

  • platform
  • resolution_strategy

About

Infra-Sight is an elegant UX focused API for Overwatch.

Topics

Resources

Stars

Watchers

Forks