https://github.com/mbta/mbta_v3_api

https://github.com/mbta/mbta_v3_api

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/mbta/mbta_v3_api
• Owner: mbta
• License: mit
• Created: 2023-11-30T22:56:22.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-02T12:33:26.000Z (5 months ago)
• Last Synced: 2024-08-02T14:13:57.889Z (5 months ago)
• Language: Elixir
• Size: 280 KB
• Stars: 0
• Watchers: 12
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# MBTAV3API

Client library for the [MBTA V3 API](https://www.mbta.com/developers/v3-api).

## Installation

The package can be installed by adding `mbta_v3_api` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:mbta_v3_api, "~> 0.0.1"}

  ]

end

```

## Configuration

In your runtime configuration (`config/runtime.exs`) provide the API URL, key, and version (all required).

```elixir

config :v3_api,

  base_url: "API_URL",

  api_key: "API_KEY",

  api_version: "2021-01-09"

```

You can also set the following optional confuration values.

- `:cache_size` - Number of items to retain in the cache (_default:_ `10_000`)

- `:populate_caches?` - Whether to pre-populate route data in the cache (_default:_ `false`)

## Documentation

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)

and published on [HexDocs](https://hexdocs.pm). Once published, the docs can

be found at .