# xapi.ie

> xapi.ie is a practical guide to the Experience API (xAPI) for developers: statements, verbs, the LRS REST API, querying, launching courses, cmi5 and versions, with curl examples. Written by Learn Skills, makers of Learn Skills LRS, a hosted xAPI 1.0.3 Learning Record Store in Ireland.

## Key facts

- An xAPI statement has an actor, a verb and an object, optionally a result and context. It is sent as JSON over HTTPS to a Learning Record Store (LRS).
- An LRS is a REST API under one base address, the endpoint. Requests use HTTP Basic authentication and the header X-Experience-API-Version: 1.0.3.
- Resources: statements, activities/state, activities/profile, agents/profile, activities, agents, about.
- GET statements filters by agent, verb, activity, registration, since, until and limit; follow the "more" URL for further pages. There is no aggregation in the standard.
- Authoring tools (Storyline, Rise, Captivate, iSpring) are launched with query parameters: endpoint, auth, actor, registration, activity_id.
- cmi5 is a profile of xAPI for courses launched by an LMS. xAPI 2.0 is IEEE 9274.1.1-2023, largely compatible with 1.0.3.

## Pages

- [xAPI, the practical guide](https://xapi.ie/)
- [tincan.ie: Tin Can explained for course authors](https://tincan.ie/)
- [Learn Skills LRS: a hosted xAPI endpoint, free plan included](https://lrs.ie/)
