Skip to main content

arccos-api banner

arccos-api

PyPI Tests Python License

Your Arccos Golf data, from the terminal or Python.

arccos-api is an unofficial, read-only client for exploring your own rounds, handicap, club distances, strokes gained, pace of play, and more.

Important: Arccos does not provide a public API. This project is not affiliated with Arccos Golf LLC, and upstream changes may occasionally require a library update.

What you can do

  • Browse rounds and hole-by-hole scoring
  • Track handicap, scoring, and strokes-gained trends
  • Inspect smart distances, club shots, and dispersion
  • Compare rounds and review personal bests
  • Explore courses, pace of play, and hole imagery metadata
  • Export data as JSON, CSV, or NDJSON
  • Use the same data through a Python client

Golf data access is read-only by design. The client only sends GET requests to the Arccos data API. Login and token refresh use the authentication service's required POST requests, but never create, edit, or delete golf or account data.

Install

Requires Python 3.11 or newer.

pip install arccos-api

For the CLI on macOS or Linux, Homebrew is also available:

brew install pfrederiksen/tap/arccos-api

Optional operating-system keyring support:

pip install 'arccos-api[keyring]'

Quick start

Authenticate once, then start exploring:

arccos login
arccos rounds
arccos handicap
arccos clubs

Some useful next steps:

arccos round 12345678            # hole-by-hole round detail
arccos stats --dashboard         # strokes-gained dashboard
arccos trends                    # handicap trend
arccos pace                      # pace of play by course
arccos export -f csv -o rounds.csv

Most display commands support --json, and every command supports --help. See the CLI guide for the complete command list, filtering, profiles, shell completion, and export examples.

Use it from Python

arccos login caches credentials, so Python can reuse them without putting a password in source code:

from arccos import ArccosClient

with ArccosClient() as client:
    rounds = client.rounds.list(limit=5)
    handicap = client.handicap.current()
    distances = client.clubs.smart_distances()

    print(f"Handicap: {handicap['userHcp']:.1f}")
    for round_ in rounds:
        print(round_["startTime"][:10], round_["noOfShots"])

You can also authenticate directly:

client = ArccosClient(email="you@example.com", password="your_password")

See the Python client guide for resources and examples, or browse the complete OpenAPI 3.1 specification.

Documentation

Guide Contents
CLI guide Commands, filters, exports, profiles, and environment variables
Python client Authentication, resources, and usage examples
OpenAPI specification Complete endpoint and schema reference
Examples Runnable Python scripts
Contributing Local setup, tests, style, and releases
Security Credential handling and vulnerability reporting
Changelog Release history

Credentials and privacy

  • Credentials are cached with owner-only permissions in your platform's config directory. Legacy ~/.arccos_creds.json files migrate automatically.
  • Named profiles are available through ARCCOS_PROFILE or command options.
  • Set ARCCOS_KEYRING=true to use the optional OS keyring integration.
  • arccos logout clears local credentials but cannot revoke upstream tokens; change your Arccos password if credentials may be compromised.
  • Use your own account and avoid aggressive polling.

Run arccos doctor to check configuration, credentials, and API connectivity. See SECURITY.md to report a vulnerability privately.

Development

git clone https://github.com/pfrederiksen/arccos-api.git
cd arccos-api
python3 -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'
pytest

Tests use mocked and sanitized responses; no Arccos account is required. See CONTRIBUTING.md for the full development workflow.

Disclaimer

Not affiliated with, endorsed by, or connected to Arccos Golf LLC. Use your own account credentials only. This project is intended for personal data access and research.

Released under the MIT License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arccos_api-0.5.4.tar.gz (69.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arccos_api-0.5.4-py3-none-any.whl (53.2 kB view details)

Uploaded Python 3

File details

Details for the file arccos_api-0.5.4.tar.gz.

File metadata

  • Download URL: arccos_api-0.5.4.tar.gz
  • Upload date:
  • Size: 69.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for arccos_api-0.5.4.tar.gz
Algorithm Hash digest
SHA256 27bd39e26fb4ac5202ca14204ea3975e684b7233ecc44471bf8c1ab6f4e8a846
MD5 1a39642ab457349d144c59b4e875d306
BLAKE2b-256 da60bec20c8072c01c6305e4dbe50ea0a7077d760a66faa218b14594860adc67

See more details on using hashes here.

Provenance

The following attestation bundles were made for arccos_api-0.5.4.tar.gz:

Publisher: release.yml on pfrederiksen/arccos-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file arccos_api-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: arccos_api-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 53.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for arccos_api-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ccff6be0ae80ae0b3a418b84e03a71d4d22bd5f0bf4681b980461c8f8508754c
MD5 60090c22f3c956484fd762eff7cc2961
BLAKE2b-256 14dbea4ffc64694841e0348bf05098ae28907e703a6527fc637d3cb88aca443b

See more details on using hashes here.

Provenance

The following attestation bundles were made for arccos_api-0.5.4-py3-none-any.whl:

Publisher: release.yml on pfrederiksen/arccos-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

This release

0.5.4 This release

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page