xivapi-swift

a simple swift client to easily work with xivapi

Installation

Swift Package Manager

1. Xcode -> File -> Add Package Dependency
2. paste this repository url: https://github.com/Eisenhuth/xivapi-swift.git
3. Add Package

Usage

//option 1 - latest schema, latest version - unverified
let client = xivapiClient() 

//option 2 - providing your own schema/version
let schema = "exdschema@2:rev:32915615cef89fdda3815f653943d24ea00761b5"
let client = xivapiClient(schema: schema, version: "7.25")

//option 3 - using the schema/version this version of the package was verified against
let client = xivapiClient(automaticallyPin: true)

Tip

It is highly recommended to specify a version and schema - alternatively use the automatic pin mentioned above to use the schema/version the package was verified against.

commonly used endpoints

let item = await client.getItem(39727) //Grade 8 Tincture of Strength
let itemMinimal = await client.getItemMinimal(39727) //only contains Name, Description, Icon
let recipe = await client.getRecipe(35585) //Recipe: Grade 8 Tincture of Strength
let map = await client.getMap(696) //Thavnair
let trait = await client.getTrait(422) //Enhanced Unmend
let action = await client.getAction(7393) //The Blackest Night

there are extensions for a lot of the data, e.g. Map has .mapPath/.compositedMapPath to get the texture paths, or TripleTriadCard's .imagePath to get the path to the card's artwork. I recommend not looking too closely at how specifically these paths are constructed, that way lies madness.

Assets

• using .assetUrl(at:) you can quickly get the URL
  • this automatically uses the client's .version
  • the client defaults to .jpg for assets
    • to get e.g. .png you would use .assetUrl(at: path, format: .png)

if let compositedMapPath = map?.compositedMapPath, let mapPath = map?.mapPath {
    let compositedMapUrl = client.compositedAssetUrl(at: compositedMapPath)
    let rawMapUrl = client.assetUrl(at: mapPath)
}

Sheets

you can provide your own Codable structs for use with .getSheet

struct MyCustomItemStruct: Codable {
    let row_id: Int
}

let myItem = await client.getSheet(.Item, id: 39727) as MyCustomItemStruct?

let myItem = await client.getSheet(name: "Item", id: 39727) as MyCustomItemStruct?

or use the built-in structs

let ttCard = await client.getSheet(.TripleTriadCard, id: 346) as TripleTriadCard?
print(ttCard?.fields.Name ?? "name") //Zenos Galvus
print(ttCard?.fields.Description ?? "description") //“Did you find...fulfillment?”

Item:Recipe lookup

the package contains a pre-generated dictionary that maps ItemID to [RecipeID]

if let recipeId = await client.getItemRecipes(itemId: 39727)?.first {
    let recipe = await client.getRecipe(recipeId)
    
    recipe?.ingredients.forEach {
        print("\($0.itemId) x\($0.amount)")
    }
}

let entireLookup = await client.getItemRecipeDict() //[ItemId : [RecipeId]]