1
|
|
|
<?php |
2
|
|
|
namespace Carpenstar\ByBitAPI\Derivatives\MarketData\FundingRateHistory\Request; |
3
|
|
|
|
4
|
|
|
use Carpenstar\ByBitAPI\Core\Helpers\DateTimeHelper; |
5
|
|
|
use Carpenstar\ByBitAPI\Core\Objects\AbstractParameters; |
6
|
|
|
|
7
|
|
|
class FundingRateHistoryRequest extends AbstractParameters |
8
|
|
|
{ |
9
|
|
|
/** |
10
|
|
|
* Product type. linear |
11
|
|
|
* @var string $category |
12
|
|
|
*/ |
13
|
|
|
protected string $category = "linear"; |
14
|
|
|
|
15
|
|
|
/** |
16
|
|
|
* Symbol name |
17
|
|
|
* @var string $symbol |
18
|
|
|
*/ |
19
|
|
|
protected string $symbol; |
20
|
|
|
|
21
|
|
|
/** |
22
|
|
|
* The start timestamp |
23
|
|
|
* @var \DateTime $startTime |
24
|
|
|
*/ |
25
|
|
|
protected \DateTime $startTime; |
26
|
|
|
|
27
|
|
|
/** |
28
|
|
|
* The end timestamp |
29
|
|
|
* @var \DateTime $endTime |
30
|
|
|
*/ |
31
|
|
|
protected \DateTime $endTime; |
32
|
|
|
|
33
|
|
|
/** |
34
|
|
|
* Limit for data size per page. [1, 200]. Default: 200 |
35
|
|
|
* @var int $limit |
36
|
|
|
*/ |
37
|
|
|
protected int $limit = 200; |
38
|
|
|
|
39
|
|
|
public function __construct() |
40
|
|
|
{ |
41
|
|
|
$this->setSymbol('symbol'); |
42
|
|
|
} |
43
|
|
|
|
44
|
|
|
/** |
45
|
|
|
* @param string $category |
46
|
|
|
* @return FundingRateHistoryRequest |
47
|
|
|
*/ |
48
|
|
|
public function setCategory(string $category): self |
49
|
|
|
{ |
50
|
|
|
$this->category = $category; |
51
|
|
|
return $this; |
52
|
|
|
} |
53
|
|
|
|
54
|
|
|
/** |
55
|
|
|
* @return string |
56
|
|
|
*/ |
57
|
|
|
public function getCategory(): string |
58
|
|
|
{ |
59
|
|
|
return $this->category; |
60
|
|
|
} |
61
|
|
|
|
62
|
|
|
/** |
63
|
|
|
* @param string $symbol |
64
|
|
|
* @return FundingRateHistoryRequest |
65
|
|
|
*/ |
66
|
|
|
public function setSymbol(string $symbol): self |
67
|
|
|
{ |
68
|
|
|
$this->symbol = $symbol; |
69
|
|
|
return $this; |
70
|
|
|
} |
71
|
|
|
|
72
|
|
|
/** |
73
|
|
|
* @return string |
74
|
|
|
*/ |
75
|
|
|
public function getSymbol(): string |
76
|
|
|
{ |
77
|
|
|
return $this->symbol; |
78
|
|
|
} |
79
|
|
|
|
80
|
|
|
/** |
81
|
|
|
* @param int $startTime |
82
|
|
|
* @return FundingRateHistoryRequest |
83
|
|
|
*/ |
84
|
|
|
public function setStartTime(int $startTime): self |
85
|
|
|
{ |
86
|
|
|
$this->startTime = DateTimeHelper::makeFromTimestamp($startTime); |
87
|
|
|
return $this; |
88
|
|
|
} |
89
|
|
|
|
90
|
|
|
/** |
91
|
|
|
* @return \DateTime |
92
|
|
|
*/ |
93
|
|
|
public function getStartTime(): \DateTime |
94
|
|
|
{ |
95
|
|
|
return $this->startTime; |
96
|
|
|
} |
97
|
|
|
|
98
|
|
|
/** |
99
|
|
|
* @param int $end |
100
|
|
|
* @return FundingRateHistoryRequest |
101
|
|
|
*/ |
102
|
|
|
public function setEndTime(int $endTime): self |
103
|
|
|
{ |
104
|
|
|
$this->endTime = DateTimeHelper::makeFromTimestamp($endTime); |
105
|
|
|
return $this; |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
/** |
109
|
|
|
* @return \DateTime |
110
|
|
|
*/ |
111
|
|
|
public function getEndTime(): \DateTime |
112
|
|
|
{ |
113
|
|
|
return $this->endTime; |
114
|
|
|
} |
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* @param int $limit |
118
|
|
|
* @return FundingRateHistoryRequest |
119
|
|
|
*/ |
120
|
|
|
public function setLimit(int $limit): self |
121
|
|
|
{ |
122
|
|
|
$this->limit = $limit; |
123
|
|
|
return $this; |
124
|
|
|
} |
125
|
|
|
|
126
|
|
|
/** |
127
|
|
|
* @return int |
128
|
|
|
*/ |
129
|
|
|
public function getLimit(): int |
130
|
|
|
{ |
131
|
|
|
return $this->limit; |
132
|
|
|
} |
133
|
|
|
} |