Labradorite

noun

1. a crystal with the properties of being able to find yourself and your wisdom
2. the name of my API to make Apple device information available with ease

---

What is it?

• A work-in-progress API server for Apple device specifications. This server is designed from the ground up to provide easy-to-use endpoints for integration into other projects (a great example is my own copy of CorpNewt's CorpBot.py)

What do I need?

Something that's capable of sending a GET request to a server, and receiving any of the following:

• application/json
• text/plain
• HTTP error codes 200, 400, 404, 405, 500

While the API works best when integrated into projects, the simplest way to get data from it is through a web browser.

How do I get it?

Just send a GET request to one of the endpoints on https://labradorite.crystall1ne.dev:

/help - Return more detailed documentation in text/plain.
/api/v0/identifier - Return information on the passed identifier (i.e. iPhone17,2).
/api/v0/model - Return information on the passed model number (i.e. A3084).
/api/v0/boardconfig - Return information on the passed boardconfig (i.e. D94AP).

For running the API server on your own device, you'll need to have one of the following operating systems¹:

• macOS Big Sur 11.0 or later
• iOS or iPadOS 14.0 or later²
• tvOS 14.0 or later²

How do I contribute?

Labradorite's API data

I'm not currently taking contributions for the data available on my server. If you want to know when I will be, hit up the #labradorite channel in my Discord server.

Labradorite's API server

1. Clone this repo
2. Open Codesigning.example.xcconfig, make changes, and save it as Codesigning.xcconfig.
3. Open Labradorite.xcworkspace
4. Select Labradorite-Server
5. Build labradorite-server!

Footnotes

1. The source code is written with zero third-party frameworks and no OS-specific code, which means that it should work on Windows, Linux, and older versions of macOS, iOS, or tvOS. I don't personally test or use the API server on these operating systems, and future development may change this case. ↩

2. Running the API server on iOS or tvOS requires a jailbreak. ↩ ↩²