Skip to content

FastAPI API Reference

App Factory

yoro.fastapi.app.create_app(prefix='')

Create the Yoro FastAPI application.

Parameters:

Name Type Description Default
prefix str

Optional URL prefix for all routes (e.g. "/api/v1/yoro").

 ''
Source code in src/yoro/fastapi/app.py 
180
181
182
183
184
185
186
187
188
189
190
191
192
def create_app(prefix: str = "") -> FastAPI:
    """Create the Yoro FastAPI application.

    Args:
        prefix: Optional URL prefix for all routes (e.g. ``"/api/v1/yoro"``).
    """
    app = FastAPI(
        title="Yoro API",
        description="Geographic addressing via Hilbert curves — GPS ↔ compact codes",
        version=__version__,
    )
    app.include_router(router, prefix=prefix)
    return app

Pydantic Schemas

yoro.fastapi.app.BoundsSchema

Bases: BaseModel

Source code in src/yoro/fastapi/app.py 
27
28
29
30
31
class BoundsSchema(BaseModel):
    lat_min: float
    lat_max: float
    lon_min: float
    lon_max: float

yoro.fastapi.app.EncodeResponse

Bases: BaseModel

Source code in src/yoro/fastapi/app.py 
34
35
36
37
38
39
40
class EncodeResponse(BaseModel):
    code: str
    lat: float
    lon: float
    precision: int
    resolution_m: float
    bounds: BoundsSchema

yoro.fastapi.app.DecodeResponse

Bases: BaseModel

Source code in src/yoro/fastapi/app.py 
43
44
45
46
47
48
49
50
51
class DecodeResponse(BaseModel):
    code: str
    lat: float
    lon: float
    precision: int
    domain: str
    resolution_m: float
    bounds: BoundsSchema
    neighbors: list[str]

yoro.fastapi.app.PrecisionLevelSchema

Bases: BaseModel

Source code in src/yoro/fastapi/app.py 
59
60
61
62
63
64
class PrecisionLevelSchema(BaseModel):
    precision: int
    code_length: int
    grid_size: int
    total_cells: int
    resolution_m: float

yoro.fastapi.app.PrecisionsResponse

Bases: BaseModel

Source code in src/yoro/fastapi/app.py 
67
68
69
class PrecisionsResponse(BaseModel):
    domain: str
    levels: list[PrecisionLevelSchema]