cablefyi

README

cablefyi-go

Go client for the CableFYI REST API. Submarine cables, connectors. Zero external dependencies beyond stdlib.

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

Install

go get github.com/fyipedia/cablefyi-go

Quick Start

package main

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

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

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

API Methods

Method	Description
Benchmarks()	List benchmarks
Cables()	List cables
Compatibility()	List compatibility
Connectors()	List connectors
Devices()	List devices
Faqs()	List faqs
GuideSeries()	List guide series
Guides()	List guides
SetupGuides()	List setup guides
Standards()	List standards
Terms()	List terms
Search(query)	Search across all content

Also Available

Platform	Package	Link
Python	pip install cablefyi	PyPI
npm	npm install cablefyi	npm
Go	go get github.com/fyipedia/cablefyi-go	pkg.go.dev
Rust	cargo add cablefyi	crates.io
Ruby	gem install cablefyi	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: cablefyi.com
• API Docs: cablefyi.com/api/v1/
• OpenAPI: cablefyi.com/api/v1/schema/

License

MIT

Documentation

Overview

Package cablefyi provides a Go client for the CableFYI API (cablefyi.com).

CableFYI — zero dependencies, no authentication required.

Usage:

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

Index

• Constants
• type Client
  • func NewClient() *Client
  • func (c *Client) Benchmark(slug string) (map[string]interface{}, error)
  • func (c *Client) Benchmarks() (map[string]interface{}, error)
  • func (c *Client) Cable(slug string) (map[string]interface{}, error)
  • func (c *Client) Cables() (map[string]interface{}, error)
  • func (c *Client) Compatibility() (map[string]interface{}, error)
  • func (c *Client) Connector(slug string) (map[string]interface{}, error)
  • func (c *Client) Connectors() (map[string]interface{}, error)
  • func (c *Client) Device(slug string) (map[string]interface{}, error)
  • func (c *Client) Devices() (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) 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) Search(query string) (map[string]interface{}, error)
  • func (c *Client) SetupGuide(slug string) (map[string]interface{}, error)
  • func (c *Client) SetupGuides() (map[string]interface{}, error)
  • func (c *Client) Standard(slug string) (map[string]interface{}, error)
  • func (c *Client) Standards() (map[string]interface{}, error)
  • func (c *Client) Term(slug string) (map[string]interface{}, error)
  • func (c *Client) Terms() (map[string]interface{}, error)

Constants

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

DefaultBaseURL is the default API base URL.

Types

type Client

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

Client is a CableFYI API client.

func NewClient

func NewClient() *Client

NewClient creates a new CableFYI API client.

func (*Client) Benchmark

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

Benchmark returns details for a benchmark by slug.

func (*Client) Benchmarks

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

Benchmarks returns a list of benchmarks.

func (*Client) Cable

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

Cable returns details for a cable by slug.

func (*Client) Cables

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

Cables returns a list of cables.

func (*Client) Compatibility

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

Compatibility returns a list of compatibility.

func (*Client) Connector

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

Connector returns details for a connector by slug.

func (*Client) Connectors

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

Connectors returns a list of connectors.

func (*Client) Device

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

Device returns details for a device by slug.

func (*Client) Devices

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

Devices returns a list of devices.

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) 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) Search

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

Search searches across all content.

func (*Client) SetupGuide

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

SetupGuide returns details for a setup guide by slug.

func (*Client) SetupGuides

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

SetupGuides returns a list of setup guides.

func (*Client) Standard

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

Standard returns details for a standard by slug.

func (*Client) Standards

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

Standards returns a list of standards.

func (*Client) Term

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

Term returns details for a term by slug.

func (*Client) Terms

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

Terms returns a list of terms.