gemfyi

README

gemfyi-go

Go client for the GemFYI REST API. Gemstones, mineralogy, grading. Zero external dependencies beyond stdlib.

Try the interactive tools at gemfyi.com — explore, search, and discover.

Install

go get github.com/fyipedia/gemfyi-go

Quick Start

package main

import (
    "fmt"
    gemfyi "github.com/fyipedia/gemfyi-go"
)

func main() {
    client := gemfyi.NewClient()

    // Search across all content
    result, err := client.Search("query")
    if err != nil {
        panic(err)
    }
    fmt.Println(result)
}

API Methods

Method	Description
Categories()	List categories
Comparisons()	List comparisons
Faqs()	List faqs
Gems()	List gems
Glossary()	List glossary
GlossaryCategories()	List glossary categories
GuideSeries()	List guide series
Guides()	List guides
Origins()	List origins
Search(query)	Search across all content

Also Available

Platform	Package	Link
Python	pip install gemfyi	PyPI
npm	npm install gemfyi	npm
Go	go get github.com/fyipedia/gemfyi-go	pkg.go.dev
Rust	cargo add gemfyi	crates.io
Ruby	gem install gemfyi	rubygems

FYIPedia Developer Tools

Part of the FYIPedia open-source developer tools ecosystem.

Package	PyPI	npm	Go	Description
airlinefyi	PyPI	npm	Go	Airlines, fleets, alliances — airlinefyi.com
airportfyi	PyPI	npm	Go	4,500+ airports, IATA/ICAO — airportfyi.com
alloyfyi	PyPI	npm	Go	Metal alloys, compositions — alloyfyi.com
anatomyfyi	PyPI	npm	Go	14,692 anatomical structures — anatomyfyi.com
barcodefyi	PyPI	npm	Go	Barcode formats, EAN, UPC, ISBN — barcodefyi.com
beerfyi	PyPI	npm	Go	112 beer styles, hops, malts, yeast — beerfyi.com
birdfyi	PyPI	npm	Go	11,251 birds, orders, conservation — birdfyi.com
blefyi	PyPI	npm	Go	Bluetooth Low Energy, GATT, beacons — blefyi.com
boardgamefyi	PyPI	npm	Go	Board games, rules, reviews — boardgamefyi.com
brewfyi	PyPI	npm	Go	72 coffee varieties, roasting, brewing — brewfyi.com
cablefyi	PyPI	npm	Go	Submarine cables, connectors — cablefyi.com
calcfyi	PyPI	npm	Go	200+ calculators — calcfyi.com
chemfyi	PyPI	npm	Go	Periodic table, elements, compounds — chemfyi.com
cocktailfyi	PyPI	npm	Go	636 cocktail recipes, ABV, calories — cocktailfyi.com
colorfyi	PyPI	npm	Go	Color science, WCAG contrast, 16.7M hex colors — colorfyi.com
dinofyi	PyPI	npm	Go	6,142 dinosaurs, paleontology — dinofyi.com
distancefyi	PyPI	npm	Go	Haversine distance & travel times — distancefyi.com
drugfyi	PyPI	npm	Go	Drug interactions, pharmacology — drugfyi.com
emojifyi	PyPI	npm	Go	Emoji metadata & encoding for 3,953 emojis — emojifyi.com
fishfyi	PyPI	npm	Go	Fish species, marine biology — fishfyi.com
fontfyi	PyPI	npm	Go	Google Fonts metadata & CSS — fontfyi.com
gemfyi	PyPI	npm	Go	Gemstones, mineralogy, grading — gemfyi.com
holidayfyi	PyPI	npm	Go	Holiday dates & Easter calculation — holidayfyi.com
ipfyi	PyPI	npm	Go	IP geolocation, ASN lookup — ipfyi.com
mineralfyi	PyPI	npm	Go	6,215 minerals, crystal systems — mineralfyi.com
mountainfyi	PyPI	npm	Go	Mountains, peaks, elevation — mountainfyi.com
namefyi	PyPI	npm	Go	Korean romanization & Five Elements — namefyi.com
nfcfyi	PyPI	npm	Go	NFC chips, tag types, NDEF — nfcfyi.com
nihonshufyi	PyPI	npm	Go	80 sake, rice varieties, breweries — nihonshufyi.com
nutrifyi	PyPI	npm	Go	Nutrition data, food composition — nutrifyi.com
pillfyi	PyPI	npm	Go	Pill identification, FDA database — pillfyi.com
planefyi	PyPI	npm	Go	Aircraft models, specifications — planefyi.com
plantfyi	PyPI	npm	Go	379,774 plants, taxonomy — plantfyi.com
qrcodefyi	PyPI	npm	Go	QR code types, versions, encoding — qrcodefyi.com
quakefyi	PyPI	npm	Go	Earthquakes, seismic data — quakefyi.com
rfidfyi	PyPI	npm	Go	RFID tags, frequency bands, standards — rfidfyi.com
salaryfyi	PyPI	npm	Go	Salary comparison, tax calculators — salaryfyi.com
smartcardfyi	PyPI	npm	Go	Smart cards, EMV, APDU, Java Card — smartcardfyi.com
speciesfyi	PyPI	npm	Go	Species taxonomy, classification — speciesfyi.com
starfyi	PyPI	npm	Go	Stars, constellations, exoplanets — starfyi.com
statuscodefyi	PyPI	npm	Go	HTTP status codes, protocols — statuscodefyi.com
symbolfyi	PyPI	npm	Go	Symbol encoding in 11 formats — symbolfyi.com
teafyi	PyPI	npm	Go	60 tea varieties, teaware, brewing — teafyi.com
timefyi	PyPI	npm	Go	Timezone ops & business hours — timefyi.com
tldfyi	PyPI	npm	Go	TLD registry, domain extensions — tldfyi.com
trainfyi	PyPI	npm	Go	Railway stations, routes, networks — trainfyi.com
unicodefyi	PyPI	npm	Go	Unicode lookup with 17 encodings — unicodefyi.com
unitfyi	PyPI	npm	Go	Unit conversion, 220 units — unitfyi.com
univfyi	PyPI	npm	Go	University rankings, programs — univfyi.com
vinofyi	PyPI	npm	Go	Wines, grapes, regions, wineries — vinofyi.com
whiskeyfyi	PyPI	npm	Go	80 whiskey expressions, distilleries — whiskeyfyi.com
zipfyi	PyPI	npm	Go	ZIP/postal codes, geocoding — zipfyi.com

Links

• Site: gemfyi.com
• API Docs: gemfyi.com/api/v1/
• OpenAPI: gemfyi.com/api/v1/schema/

License

MIT

Documentation

Overview

Package gemfyi provides a Go client for the GemFYI API (gemfyi.com).

GemFYI — zero dependencies, no authentication required.

Usage:

client := gemfyi.NewClient()
result, err := client.Search("query")

Index

• Constants
• type Client
  • func NewClient() *Client
  • func (c *Client) Categories() (map[string]interface{}, error)
  • func (c *Client) Category(slug string) (map[string]interface{}, error)
  • func (c *Client) Comparison(slug string) (map[string]interface{}, error)
  • func (c *Client) Comparisons() (map[string]interface{}, error)
  • func (c *Client) Faq(slug string) (map[string]interface{}, error)
  • func (c *Client) Faqs() (map[string]interface{}, error)
  • func (c *Client) Gem(slug string) (map[string]interface{}, error)
  • func (c *Client) Gems() (map[string]interface{}, error)
  • func (c *Client) Glossary() (map[string]interface{}, error)
  • func (c *Client) GlossaryCategories() (map[string]interface{}, error)
  • func (c *Client) GlossaryCategory(slug string) (map[string]interface{}, error)
  • func (c *Client) Guide(slug string) (map[string]interface{}, error)
  • func (c *Client) GuideSeries() (map[string]interface{}, error)
  • func (c *Client) GuideSery(slug string) (map[string]interface{}, error)
  • func (c *Client) Guides() (map[string]interface{}, error)
  • func (c *Client) Origin(slug string) (map[string]interface{}, error)
  • func (c *Client) Origins() (map[string]interface{}, error)
  • func (c *Client) Search(query string) (map[string]interface{}, error)
  • func (c *Client) Term(slug string) (map[string]interface{}, error)

Constants

const DefaultBaseURL = "https://gemfyi.com"

DefaultBaseURL is the default API base URL.

Types

type Client

type Client struct {
	BaseURL    string
	HTTPClient *http.Client
}

Client is a GemFYI API client.

func NewClient

func NewClient() *Client

NewClient creates a new GemFYI API client.

func (*Client) Categories

func (c *Client) Categories() (map[string]interface{}, error)

Categories returns a list of categories.

func (*Client) Category

func (c *Client) Category(slug string) (map[string]interface{}, error)

Category returns details for a category by slug.

func (*Client) Comparison

func (c *Client) Comparison(slug string) (map[string]interface{}, error)

Comparison returns details for a comparison by slug.

func (*Client) Comparisons

func (c *Client) Comparisons() (map[string]interface{}, error)

Comparisons returns a list of comparisons.

func (*Client) Faq

func (c *Client) Faq(slug string) (map[string]interface{}, error)

Faq returns details for a FAQ by slug.

func (*Client) Faqs

func (c *Client) Faqs() (map[string]interface{}, error)

Faqs returns a list of faqs.

func (*Client) Gem

func (c *Client) Gem(slug string) (map[string]interface{}, error)

Gem returns details for a gem by slug.

func (*Client) Gems

func (c *Client) Gems() (map[string]interface{}, error)

Gems returns a list of gems.

func (*Client) Glossary

func (c *Client) Glossary() (map[string]interface{}, error)

Glossary returns a list of glossary.

func (*Client) GlossaryCategories

func (c *Client) GlossaryCategories() (map[string]interface{}, error)

GlossaryCategories returns a list of glossary categories.

func (*Client) GlossaryCategory

func (c *Client) GlossaryCategory(slug string) (map[string]interface{}, error)

GlossaryCategory returns details for a glossary category by slug.

func (*Client) Guide

func (c *Client) Guide(slug string) (map[string]interface{}, error)

Guide returns details for a guide by slug.

func (*Client) GuideSeries

func (c *Client) GuideSeries() (map[string]interface{}, error)

GuideSeries returns a list of guide series.

func (*Client) GuideSery

func (c *Client) GuideSery(slug string) (map[string]interface{}, error)

GuideSery returns details for a guide sery by slug.

func (*Client) Guides

func (c *Client) Guides() (map[string]interface{}, error)

Guides returns a list of guides.

func (*Client) Origin

func (c *Client) Origin(slug string) (map[string]interface{}, error)

Origin returns details for a origin by slug.

func (*Client) Origins

func (c *Client) Origins() (map[string]interface{}, error)

Origins returns a list of origins.

func (*Client) Search

func (c *Client) Search(query string) (map[string]interface{}, error)

Search searches across all content.

func (*Client) Term

func (c *Client) Term(slug string) (map[string]interface{}, error)

Term returns details for a Term by slug.