EOS API Interface List

List of all interfaces in the EOS API

Achievements Interface

The following EOS_Achievements_* functions allow you to query existing achievement definitions that have been defined for your application. You can also query achievement progress data for users. In addition, you can also unlock one or more achievements directly. You can also receive notifications when achievements are unlocked.

You can dive deeper into the Achievements Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

AntiCheatClient Interface

You can dive deeper into the AntiCheatClient Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

AntiCheatServer Interface

You can dive deeper into the AntiCheatServer Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Auth Interface

The Auth Interface is used to manage local user permissions and access to backend services through the verification of various forms of credentials. All Auth Interface calls take a handle of type EOS_HAuth as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetAuthInterface function.

You can dive deeper into the Auth Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Connect Interface

The Connect Interface is used to manage local user permissions and access to backend services through the verification of various forms of credentials. It creates an association between third party providers and an internal mapping that allows Epic Online Services to represent a user agnostically. All Connect Interface calls take a handle of type EOS_HConnect as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetConnectInterface function.

You can dive deeper into the Connect Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Ecom Interface

The Ecom Interface exposes all catalog, purchasing, and ownership entitlement features available with the Epic Games store All Ecom Interface calls take a handle of type EOS_HEcom as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetEcomInterface function.

You can dive deeper into the Ecom Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Friends Interface

The Friends Interface is used to manage a user's friends list, by interacting with the backend services, and to retrieve the cached list of friends and pending invitations. All Friends Interface calls take a handle of type EOS_HFriends as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetFriendsInterface function.

You can dive deeper into the Friends Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

KWS Interface

This interface is not available for general access at this time. The KWS Interface exists as an integration for age gating functionality provided by Kids Web Services from SuperAwesome, using the EOS Connect interface. All KWS Interface calls take a handle of type EOS_HKWS as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetKWSInterface function.

You can dive deeper into the KWS Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Leaderboards Interface

The following EOS_Leaderboards_* functions allow you to query existing leaderboard definitions that have been defined for your application. You can retrieve a list of scores for the top users for each Leaderboard. You can also query scores for one or more users.

You can dive deeper into the Leaderboards Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Lobby Interface

The Lobby Interface is used to manage lobbies that provide a persistent connection between users and notifications of data sharing/updates. Lobbies may also be found by advertising and searching with the backend service. All Lobby Interface calls take a handle of type EOS_HLobby as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetLobbyInterface function.

You can dive deeper into the Lobby Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Metrics Interface

The Metrics Interface tracks your application's usage and populates the Game Analytics dashboard in the Developer Portal. This data includes active, online instances of the game's client and server, and past sessions played by local players. All Metrics Interface calls take a handle of type EOS_HMetrics as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetMetricsInterface function.

You can dive deeper into the Metrics Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Mods Interface

The Mods Interface is used to manage a user's mods. Allowing a user to install/uninstall/enumerate mods. All Mods Interface calls take a handle of type EOS_HMods as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetModsInterface function. NOTE: At this time, this feature is only available for desktop platforms and for products that are part of the Epic Games store.

You can dive deeper into the Mods Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

P2P Interface

P2P functions to help manage sending and receiving of messages to peers. These functions will attempt to punch through NATs, but will fallback to using Epic relay servers if a direct connection cannot be established.

You can dive deeper into the P2P Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

PlayerDataStorage Interface

The following EOS_PlayerDataStorage_* functions allow you to query file metadata; create/upload files; and duplicate, read, and delete existing files

You can dive deeper into the PlayerDataStorage Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Presence Interface

The Presence methods enable you to query and read other player's presence information, or modify your own. QueryPresence must be called once per login, per remote user, before data will be available. It is currently only possible to query presence for users that are on your friends list, all other queries will return no results.

You can dive deeper into the Presence Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

ProgressionSnapshot Interface

Progression Snapshots allow you to store player specific game state. BeginSnapshot must be called to obtain a handle for a given player. AddProgression allows you to add Key/Value pairs that represent some state for that player in the game. SubmitSnapshot sends all the progression data you have added (via AddProgression) to the service. EndSnapshot cleans up internal resources allocated for that snapshot. DeleteSnapshot wipes out all data associated with a particular player.

You can dive deeper into the ProgressionSnapshot Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Reports Interface

The following EOS_Reports_* functions allow you to send reports directly from the players to the back-end services without having to route these through a game server.

You can dive deeper into the Reports Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

RTC Interface

The RTC Interface is used to manage joining and leaving rooms.

You can dive deeper into the RTC Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Sanctions Interface

You can dive deeper into the Sanctions Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Sessions Interface

The Session Interface is used to manage sessions that can be advertised with the backend service All Session Interface calls take a handle of type EOS_HSessions as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetSessionsInterface function.

You can dive deeper into the Sessions Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Stats Interface

The Stats Interface manages user stats like number of items collected, fastest completion time for a level, number of wins/losses, number of times that a user has performed a certain action, and so on. You can use stats to determine when to unlock achievements and how to use rank users in leaderboards. All Stats Interface calls take a handle of type EOS_HStats as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetStatsInterface function.

You can dive deeper into the Stats Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

TitleStorage Interface

The following EOS_TitleStorage_* functions allow you to query metadata for available files from title storage as well as download and read their contents.

You can dive deeper into the TitleStorage Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

UI Interface

The UI Interface is used to access the Social Overlay UI. Each UI component will have a function for opening it. All UI Interface calls take a handle of type EOS_HUI as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetUIInterface function.

You can dive deeper into the UI Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

UserInfo Interface

The UserInfo Interface is used to receive user information for Epic Account IDs from the backend services and to retrieve that information once it is cached. All UserInfo Interface calls take a handle of type EOS_HUserInfo as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetUserInfoInterface function.

You can dive deeper into the UserInfo Interface API Reference for a complete technical reference, or receive guidance and usage instructions from the main documentation site.

Tags