FamilySearch C# SDK

About

Welcome to the official C# SDK for the FamilySearch API.

The FamilySearch C# SDK is developed as an extension to the GEDCOM X C# library, which is a full implementation of the GEDCOM X Specification Set. This is because the FamilySearch API is an implementation of the GEDCOM X RS Specification, plus some custom FamilySearch extensions.

Coordinates

The C# SDK is available via NuGet:

Package ID Link
FamilySearch.API.SDK http://www.nuget.org/packages/FamilySearch.API.SDK/

Use

The C# SDK extends the GEDCOM X RS Client. In addition to the base functionality of the GEDCOM X RS Client, the SDK provides additional model classes, convenience classes, and methods to support FamilySearch-specific functionality.

The FamilySearch API uses hypermedia as the engine of application state and so using a client feels like browsing the web. As such, the SDK feels like using a screen scraper. The process can generally be summarized as follows:

  1. Read the "Home" Collection
    Web sites have a "home page". The FamilySearch API has "home collections". Examples of collections include the FamilySearch Family Tree, FamilySearch Memories, and FamilySearch Records.
  2. Follow the Right Link
    You get stuff done on a web site by following links to where you want to go. Ditto for the FamilySearch API.
  3. Follow the Right Link
    Follow more links to get more stuff done.

Examples

For a set of examples of how to use the SDK, refer to the README.

Build

See the README for information about how to build the SDK from source.

Issues

Issues can be submitted issues using the issue tracker. Better yet, create a pull request.

Change Language
Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.