{"id":36761744,"url":"https://github.com/dant89/ix-api-php-client","last_synced_at":"2026-01-12T12:56:03.149Z","repository":{"id":56962235,"uuid":"208429278","full_name":"dant89/ix-api-php-client","owner":"dant89","description":"This project features a PHP client for the IX-API","archived":false,"fork":false,"pushed_at":"2024-11-13T16:39:01.000Z","size":88,"stargazers_count":4,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"master-v2","last_synced_at":"2025-05-17T01:36:19.314Z","etag":null,"topics":["ix-api","ix-api-client","ix-api-php-client","ixapi","ixapi-php-client","php-api-client","php-client"],"latest_commit_sha":null,"homepage":"https://ix-api.net","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dant89.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-14T11:14:54.000Z","updated_at":"2023-08-30T10:28:25.000Z","dependencies_parsed_at":"2022-08-21T09:50:14.525Z","dependency_job_id":null,"html_url":"https://github.com/dant89/ix-api-php-client","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/dant89/ix-api-php-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dant89%2Fix-api-php-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dant89%2Fix-api-php-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dant89%2Fix-api-php-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dant89%2Fix-api-php-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dant89","download_url":"https://codeload.github.com/dant89/ix-api-php-client/tar.gz/refs/heads/master-v2","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dant89%2Fix-api-php-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T12:22:26.515Z","status":"ssl_error","status_checked_at":"2026-01-12T12:22:10.856Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ix-api","ix-api-client","ix-api-php-client","ixapi","ixapi-php-client","php-api-client","php-client"],"created_at":"2026-01-12T12:56:03.076Z","updated_at":"2026-01-12T12:56:03.135Z","avatar_url":"https://github.com/dant89.png","language":"PHP","readme":"# IX-API PHP Client\n\n[![Latest Stable Version][packagist-image]][packagist-url]\n[![Github Issues][github-issues-image]][github-issues-url]\n\nA lightweight PHP API client for the [IX-API](https://ix-api.net).\n\n## Installation\n\nTo install, run `composer require dant89/ix-api-client` in the root of your project or add `dant89/ix-api-client` to your composer.json.\n\nView the tagged versions to choose between `v1` and `v2` implementations of this client.\n```json\n\"require\": {\n    \"dant89/ix-api-client\": \"^LATEST_VERSION_TAG\"\n}\n```\n\n## Usage\n\nUse your provided key / secret credentials for the given implementor URL to return and then set a bearer token:\n\n```php\nuse Dant89\\IXAPIClient\\Client;\n\n// Create base client\n$client = new Client(IXAPI_URL);\n\n// Get a bearer token from key / secret\n$response = $client-\u003egetHttpClient(HttpClientType::AUTH)\n    -\u003epostAuthToken(IXAPI_KEY, IXAPI_SECRET);\n\n// Check for valid response status\nif ($response-\u003egetStatus() === 200) {\n    $client-\u003esetBearerToken($response-\u003egetContent()['access_token']);\n}\n```\n\nWith the bearer token set, you can return data from all endpoints that require authentication.\n\n**Get Product Offerings:**\n```php\n// Query for products\n$response = $client-\u003egetHttpClient(HttpClientType::PRODUCT_OFFERINGS)\n    -\u003eget();\n\n// Check for valid response and set the array of products\nif ($response-\u003egetStatus() === 200) {\n    $productOfferings = $response-\u003egetContent();\n}\n````\n\n**Method Support and Filters:**\n\nAll base clients have support for `get`, `delete`, `post`, `patch`.\n\nAdditional methods are available where supported, for example `getStatistics`, `getLoa`.\n\n```php\n$singleItem = $client-\u003egetHttpClient(HttpClientType::CONTACTS)\n    -\u003eget('item-uuid')\n    -\u003egetContent();\n    \n$filteredItems = $client-\u003egetHttpClient(HttpClientType::CONTACTS)\n    -\u003eget(null, ['managing_account' =\u003e 'uuid-123'])\n    -\u003egetContent();\n\n$response = $client-\u003egetHttpClient(HttpClientType::CONTACTS)\n    -\u003epost([\n        'managing_account' =\u003e 'uuid-123',\n        'consuming_account' =\u003e 'uuid-456',\n        'name' =\u003e 'sample contact',\n    ]);\n    \n$client-\u003egetHttpClient(HttpClientType::CONTACTS)\n    -\u003epatch('item-uuid', [\n        'name' =\u003e 'renamed sample contact',\n    ]);\n    \n$client-\u003egetHttpClient(HttpClientType::CONTACTS)\n    -\u003edelete('item-uuid');\n\n// Query for connections timeseries data\n$timeseries = $client-\u003egetHttpClient(HttpClientType::CONNECTIONS)\n    -\u003egetStatisticTimeseries('connection-123-uuid', '30d')\n    -\u003egetContent();\n````\n\n\n## Authentication\n\nYou will need to contact an exchange to create an API key / secret combination and find out the URL of their IX-API implementation.\n\n## Questions\n\nQ. The IX-API is OpenAPI 3 compliant, why don't I just create a client using a tool such as [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)?\n\nA. Please do! This client is intended to be very lightweight and something you can use to jump in, build on and experiment with. Clients generated by automated tools, such as [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) can have more depth and functionality that you may find your application requires.\n\n\n## Contributions\n\nContributions to the client are welcome, to contribute please:\n\n1. Fork this repository\n2. Create your feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a new pull request\n\n[packagist-image]: https://img.shields.io/packagist/vpre/dant89/ix-api-client.svg\n[packagist-url]: https://packagist.org/packages/dant89/ix-api-client\n\n[github-issues-image]: https://img.shields.io/github/issues/dant89/ix-api-php-client\n[github-issues-url]: https://github.com/dant89/ix-api-php-client/issues\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdant89%2Fix-api-php-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdant89%2Fix-api-php-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdant89%2Fix-api-php-client/lists"}