Skip to content

optimization on ReadMe #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
doris-xiao-bybit merged 2 commits into from
Jul 27, 2026
Merged

optimization on ReadMe #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac1726a
optimization on ReadMe
doris-xiao-bybit Jul 27, 2026
6442985
add php sdk packagist version
doris-xiao-bybit Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# bybit-connector-php

[![Packagist version](https://img.shields.io/packagist/v/bybit-exchange/bybit-connector-php.svg)](https://packagist.org/packages/bybit-exchange/bybit-connector-php)
[![PHP ≥ 8.1](https://img.shields.io/badge/php-%E2%89%A58.1-brightgreen.svg)](https://www.php.net)
[![PHPStan level 6](https://img.shields.io/badge/PHPStan-level%206-777bb4.svg)](https://phpstan.org)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
[![CI](https://github.com/bybit-exchange/bybit.php.api/actions/workflows/ci.yml/badge.svg)](https://github.com/bybit-exchange/bybit.php.api/actions/workflows/ci.yml)

Official lightweight PHP connector for the [Bybit V5 REST API](https://bybit-exchange.github.io/docs/v5/intro).

`bybit-connector-php` wraps the Bybit V5 HTTP endpoints as a set of typed PHP methods with explicit required arguments plus an `array $options = []` catch-all for optional parameters. Its goal is the same as [`pybit`](https://github.com/bybit-exchange/pybit) on the Python side and [`bybit-connector-ruby`](https://github.com/bybit-exchange/bybit.ruby.api) on the Ruby side: an easy-to-use, high-performance connector with a small dependency footprint.
Expand Down Expand Up @@ -265,7 +271,8 @@ do {
```

The same pattern works for `getClosedPnl`, `getTransactionLog`,
`getExecutionList`, and every other paginated endpoint.
`$client->trade->getHistory()` (execution list), and every other paginated
endpoint.

## Signing Invariant (for the curious)

Expand Down
Loading