Railway Python GraphQL API Client
A fully typed Python client for the Railway GraphQL API.
Railway doesn't publish an official Python SDK, but they do expose a complete GraphQL schema via introspection. This library is auto-generated from that schema, giving you a typed Python wrapper around every query and mutation in the Railway API — no manual maintenance required.
Install
uv add railway-client
Quick Start
from railway import RailwayClient
client = RailwayClient(api_token="your-api-token")
# Get current user — returns a Pydantic model, not a raw dict
user = client.me()
print(user.name, user.email)
# List all projects
projects = client.projects()
for edge in projects.edges:
print(edge.node.name)
# Create a project — input fields are expanded as kwargs
project = client.project_create(name="my-app", workspace_id="your-workspace-id")
print(project.id, project.name)
# Get variables for a service
vars = client.variables(
environment_id="env-id",
project_id="project-id",
service_id="service-id",
)
All response types are Pydantic models with snake_case field names. The camelCase↔snake_case mapping is handled declaratively via alias_generator — no runtime string conversion.
Project Token Authentication
client = RailwayClient(project_token="your-project-token")
Context Manager
with RailwayClient(api_token="token") as client:
me = client.me()
print(me.name)
Raw GraphQL
data = client._execute("""
query {
me { name email }
}
""")
API Reference
Every query and mutation in the Railway GraphQL API has a corresponding method on RailwayClient. All methods return fully typed Pydantic models with snake_case attributes. Input fields are expanded as kwargs — no need to import input types.
Use your editor's autocomplete to explore the full API. Here are some common operations:
Projects
# List projects
projects = client.projects()
for edge in projects.edges:
print(edge.node.name)
# Create a project
project = client.project_create(name="my-app", workspace_id="...")
# Update a project
client.project_update(id="proj-id", name="new-name")
# Delete a project
client.project_delete(id="proj-id")
Services
# Create a service
service = client.service_create(project_id="proj-id", name="api")
# Update a service
client.service_update(id="svc-id", name="new-name", icon="🚀")
# Get service instance
instance = client.service_instance(environment_id="env-id", service_id="svc-id")
print(instance.start_command, instance.num_replicas)
Deployments
# List deployments
deps = client.deployments(project_id="proj-id", environment_id="env-id", service_id="svc-id")
# Get build/deploy logs
logs = client.build_logs(deployment_id="dep-id")
for log in logs:
print(log.timestamp, log.message)
# Restart / rollback / cancel
client.deployment_restart(id="dep-id")
client.deployment_rollback(id="dep-id")
Variables
# Get variables
vars = client.variables(
environment_id="env-id",
project_id="proj-id",
service_id="svc-id",
)
# Set a variable
client.variable_upsert(
project_id="proj-id",
environment_id="env-id",
service_id="svc-id",
name="DATABASE_URL",
value="postgres://...",
)
Environments
# Create an environment
env = client.environment_create(project_id="proj-id", name="staging")
# List environments
envs = client.environments(project_id="proj-id")
Domains
# Get all domains for a service
domains = client.domains(
environment_id="env-id",
project_id="proj-id",
service_id="svc-id",
)
# Create a service domain
domain = client.service_domain_create(
environment_id="env-id",
service_id="svc-id",
)
Volumes
# Create a volume
volume = client.volume_create(project_id="proj-id")
# Update mount path
client.volume_instance_update(
volume_id="vol-id",
environment_id="env-id",
mount_path="/data",
service_id="svc-id",
)
Development
Generated from the Railway GraphQL schema using scripts/generate.py:
# Fetch the schema and regenerate
curl -s -X POST https://backboard.railway.com/graphql/v2 \
-H "Content-Type: application/json" \
-d '{"query":"{ __schema { types { name kind description fields { name description type { name kind ofType { name kind ofType { name kind ofType { name kind } } } } args { name description type { name kind ofType { name kind ofType { name kind ofType { name kind } } } } defaultValue } } inputFields { name description type { name kind ofType { name kind ofType { name kind ofType { name kind } } } } defaultValue } enumValues { name description } possibleTypes { name } } directives { name description locations args { name description type { name kind ofType { name kind } } defaultValue } } queryType { name } mutationType { name } subscriptionType { name } } }"}' \
> schema.json
python scripts/generate.py schema.json
License
MIT
Metadata
Release files for railway-client 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| railway_client-0.1.0.tar.gz | 49.2 kB | Without provenance | Details for railway_client-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| railway_client-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for railway_client-0.1.0-py3-none-any.whl |
Total release size: 94.9 kB
Release files / railway_client-0.1.0.tar.gz
| Download URL | railway_client-0.1.0.tar.gz |
|---|---|
| Size | 49.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2a7ed8b0308f8a4c6eb6d46e2bbabf6c1cc4b046e3909ab317665848d2ef3547
|
|
BLAKE2b-256 checksum How to use checksums |
f61c83a82b1e671cf315df7289d129e2261afb54bdaa881dafe2f42f620cd888
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / railway_client-0.1.0-py3-none-any.whl
| Download URL | railway_client-0.1.0-py3-none-any.whl |
|---|---|
| Size | 45.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c0d44a0c28cd630158fde3344fffadbce395f34bee09136586f23a944a795b47
|
|
BLAKE2b-256 checksum How to use checksums |
9bf78cc6bd88b21ee7d75440cfd3733b5ae0dcee2d1b591ab8edf7ce3488bde4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for railway-client 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.