Class API

Make requests to NameMC API

example

Get player friends

const api = new API();

api.profile.friends({
    target: '2e9d9da1-97e9-4564-890b-6f056c4e372f'
});

Hierarchy

API

Index

Properties

Properties

Readonly profile

profile: { friends: any }

Profile API section methods

Type declaration

friends:function
- friends(params: IParams): Promise<IFriend[]>
- - Defined in api/index.ts:45
  Get player friends
  
  Parameters
  - params: IParams
  Returns Promise<IFriend[]>

Readonly server

server: { likes: any }

Server API section methods

Type declaration

likes:function
- likes(params: IParams): Promise<string[]>
- likes(params: IServerLikesParams): Promise<boolean>
- - Defined in api/index.ts:54
  Check player server like
  
  Parameters
  - params: IParams
  Returns Promise<string[]>
- - Defined in api/index.ts:58
  Get all players list server likes
  
  Parameters
  - params: IServerLikesParams
  Returns Promise<boolean>

Static ENDPOINT

ENDPOINT: string = 'https://api.namemc.com'

Generated using TypeDoc