CollegeRoi SDK

CollegeRoi SDK

LE TEEN College ROI API client, generated from the OpenAPI spec.

Free, keyless, CORS-open JSON over the LE TEEN college-ROI data spine.

Learn more about LE TEEN College ROI API at le-teen.com/api.

This is an unofficial SDK for the LE TEEN College ROI public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

Learn more about Voxgig SDKs at voxgig.com/sdk.

Metadata kindly supplied by www.freepublicapis.com.

TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as 10 semantic entities that you call directly, instead of assembling URL paths and query strings. See the Entities table below for the full list. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list, load):

const client = new CollegeRoiSDK()
const items = await client.BestValue().list()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Offline unit testing

Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

TypeScript

const client = CollegeRoiSDK.test()
const bestvalues = await client.BestValue().list()
// bestvalues is an array of bare BestValue records populated with mock data
console.log(bestvalues)

Python

client = CollegeRoiSDK.test()
bestvalues = client.BestValue().list()
print(bestvalues)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = CollegeRoiSDK::test([
    "entity" => ["bestvalue" => ["test01" => []]],
]);
$bestvalues = $client->BestValue()->list();

Golang

client := sdk.Test()
result, err := client.BestValue(nil).List(
    nil, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = CollegeRoiSDK.test({
  "entity" => { "bestvalue" => { "test01" => {} } },
})
bestvalues = client.BestValue.list()

Lua

local client = sdk.test()
local results, err = client:BestValue():list()

Packages

LanguagePackageInstall
TypeScript@voxgig-sdk/college-roipublish pending — install from git tag
Pythonvoxgig-sdk-college-roipublish pending — install from git tag
PHPvoxgig-sdk/college-roipublish pending — install from git tag
Golanggithub.com/voxgig-sdk/college-roi-sdk/gogo get github.com/voxgig-sdk/college-roi-sdk/go@latest
Rubyvoxgig-sdk-college-roipublish pending — install from git tag
Luavoxgig-sdk-college-roipublish pending — install from git tag
Go CLIgithub.com/voxgig-sdk/college-roi-sdk/go-cligo install github.com/voxgig-sdk/college-roi-sdk/go-cli/cmd/college-roi@latest
Go MCP servergithub.com/voxgig-sdk/college-roi-sdk/go-mcpgo get github.com/voxgig-sdk/college-roi-sdk/go-mcp@latest

Quickstart

TypeScript

import { CollegeRoiSDK } from '@voxgig-sdk/college-roi'

const client = new CollegeRoiSDK()

// List all bestvalues (returns BestValue[])
const bestvalues = await client.BestValue().list()
for (const bestvalue of bestvalues) {
  console.log(bestvalue)
}

// Load a specific slug (returns a Slug)
const slug = await client.Slug().load({
  slug: 'example_slug',
})
console.log(slug)

See the TypeScript README for the full guide.

Surfaces

SurfacePath
SDK (TypeScript, Python, PHP, Golang, Ruby, Lua)ts/ py/ php/ go/ rb/ lua/
CLIgo-cli/
MCP servergo-mcp/

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o college-roi-mcp .

Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "college-roi": {
      "command": "/abs/path/to/college-roi-mcp"
    }
  }
}

Entities

The API exposes 10 entities:

EntityDescriptionAPI path
BestValueThe BestValue entity (list)./api/v1/rankings/best-value.json
CollegeThe College entity (list)./api/v1/colleges.json
IndexThe Index entity (load)./api/v1/index.json
MajorThe Major entity (list)./api/v1/majors.json
OpenapiThe Openapi entity (load)./api/v1/openapi.json
OutOfStatePenaltyThe OutOfStatePenalty entity (list)./api/v1/rankings/out-of-state-penalty.json
SlugThe Slug entity (load)./api/v1/colleges/{slug}.json
StateThe State entity (list)./api/v1/rankings/best-value/{state}.json
Top50The Top50 entity (list)./api/v1/rankings/out-of-state-penalty/top-50.json
WorstRoiMajorThe WorstRoiMajor entity (list)./api/v1/rankings/worst-roi-majors.json

The operations available across these entities are load, list — see each entity’s own list above for exactly which it supports.

Quickstart in other languages

Python

from collegeroi_sdk import CollegeRoiSDK

client = CollegeRoiSDK()

# List all bestvalues (returns a list, raises on error)
bestvalues = client.BestValue().list()
for bestvalue in bestvalues:
    print(bestvalue)

PHP

<?php
require_once 'collegeroi_sdk.php';

$client = new CollegeRoiSDK();

// List all bestvalues (returns an array; throws on error)
$bestvalues = $client->BestValue()->list();
print_r($bestvalues);

Golang

import sdk "github.com/voxgig-sdk/college-roi-sdk/go"

client := sdk.New()

// List all bestvalues
bestValues, err := client.BestValue(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(bestValues)

// Load a specific slug
slug, err := client.Slug(nil).Load(
    map[string]any{"slug": "example_slug"}, nil,
)
if err != nil {
    panic(err)
}
fmt.Println(slug)

Ruby

require_relative "CollegeRoi_sdk"

client = CollegeRoiSDK.new

# List all bestvalues (returns an Array; raises on error)
bestvalues = client.BestValue.list
puts bestvalues

Lua

local sdk = require("college-roi_sdk")

local client = sdk.new()

-- List all bestvalues
local bestvalues, err = client:BestValue():list()
print(bestvalues)

Direct and prepare

For endpoints the entity model doesn’t cover, use the low-level methods:

  • direct(fetchargs) — build and send an HTTP request in one step.
  • prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})
if err != nil {
    panic(err)
}
fmt.Println(result)

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

  1. Point — resolve the API endpoint from the operation definition.
  2. Spec — build the HTTP specification (URL, method, headers, body).
  3. Request — send the HTTP request.
  4. Response — receive and parse the response.
  5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

FeaturePurpose
TestFeatureIn-memory mock transport for testing without a live server

Pass custom features via the extend option at construction time.

Per-language documentation

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.


Generated from the LE TEEN College ROI API OpenAPI spec by @voxgig/sdkgen.

Get the Voxgig dispatch

Short notes on building SDKs, CLIs, REPLs, and MCPs for API-first teams, plus the occasional Fireside episode pick.

By signing up you agree to our Terms and Conditions.