wdevs/laravel-avesapi

Easily work with the Avesapi API in a Laravel application.

1.1 2021-11-30 09:32 UTC

This package is auto-updated.

Last update: 2022-06-29 02:17:52 UTC


README

Laravel package for the Avesapi API.

Getting Started

Run the following command to install this package into your project.

composer require wdevs/laravel-avesapi

Optional: publish the config files with the following command:

php artisan vendor:publish --provider="WDevs\LaravelAvesapi\Providers\LaravelAvesapiServiceProvider"

Set the environment variables in your .env file like this:

AVESAPI_API_KEY="YOURAPIKEY"

Prerequisites

You will need Composer to install this package and a valid Avesapi API key.

Installing

After installing this package with Composer, create a new Avesapi instance. And set the Avesapi API key in your env file.

Something like this:

$client = new LaravelAvesapi();

And call the desired endpoint

$client->search()->searchFor('bitcoin');

The current implemented endpoints are:

  • GET /search

Documentation for the available parameters can be found here: https://www.avesapi.com/docs/search-api/overview

Running the tests

Copy the phpunit.xml.dist and rename it to phpunit.xml. Set the env variables in the phpunit.xml files.

PLEASE NOTE: running the tests will cost you credits!!!!

  • AVESAPI_API_KEY: A valid Avesapi API key

Please see the phpunit.xml.dist for the template.

Run the tests in the Tests directory with PHPUnit.

Built With

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please help us to develop this package. Every input and/or feedback is really appreciated! Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email us instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.