@infra-sight/sdk v2.0.0-alpha.0

Infra Sight

Table of Contents

• Quick Start
• SDK
  • getOverwatchAccount
  • getOverwatchHeroes
  • getOverwatchPlayerIcons
  • getOverwatchProfile
  • searchOverwatchAccounts
• API
  • GET /v2/api/overwatch/accounts/{username}
  • GET /v2/api/overwatch/heroes
  • GET /v2/api/overwatch/player-icons
  • GET /v2/api/overwatch/profiles/{username}
  • GET /v2/api/overwatch/search/accounts/{username}

Quick Start

npm install @infra-sight/sdk

import InfraSight from '@infra-sight/sdk'

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

console.log(profile)

SDK

getOverwatchAccount

Example

import InfraSight from '@infra-sight/sdk'

const account = await InfraSight.getOverwatchAccount()

console.log(account)

Returns Promise<InfraSightAccount>

getOverwatchHeroes

Example

import InfraSight from '@infra-sight/sdk'

const heroes = await InfraSight.getOverwatchHeroes()

console.log(heroes)

Returns Promise<OverwatchHeroList>

getOverwatchPlayerIcons

Example

import InfraSight from '@infra-sight/sdk'

const icons = await InfraSight.getOverwatchPlayerIcons()

console.log(icons)

Returns Promise<InfraSightPlayerIconRecord>

getOverwatchProfile

Example

import InfraSight from '@infra-sight/sdk'

const profile = await InfraSight.getOverwatchProfile()

console.log(profile)

Returns Promise<InfraSightProfile>

searchOverwatchAccounts

Example

import InfraSight from '@infra-sight/sdk'

const accounts = await InfraSight.searchOverwatchAccounts()

console.log(accounts)

Returns Promise<InfraSightAccountList>

API

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

Parameters

• platform
• resolution_strategy

GET /v2/api/overwatch/heroes

GET /v2/api/overwatch/player-icons

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

Parameters

• platform
• resolution_strategy

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