添加 exchange文档2
							parent
							
								
									56fc2fb336
								
							
						
					
					
						commit
						729365c277
					
				
							
								
								
									
										229
									
								
								exchange%E6%96%87%E6%A1%A32.md
									
									
									
									
									
										Normal file
									
								
							
							
								
								
								
								
								
								
									
										
										
									
									
								
							
						
						
									
										229
									
								
								exchange%E6%96%87%E6%A1%A32.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,229 @@ | |||||||
|  | **exchange.go中文文档** | ||||||
|  | 
 | ||||||
|  | ### 类: Exchange | ||||||
|  | 
 | ||||||
|  | #### 描述 | ||||||
|  | Exchange 是 CCXT Go 的一个核心类,用于处理交易对的交换。 | ||||||
|  | 
 | ||||||
|  | #### 方法 | ||||||
|  | 
 | ||||||
|  | *   `NewExchange() (Exchange, error)` | ||||||
|  |     *   **方法签名**: `func NewExchange() (Exchange, error)` | ||||||
|  |     *   **说明**: 创建新的 Exchange 实例。 | ||||||
|  | *   `SetURL(url string) error` | ||||||
|  |     *   **方法签名**: `func SetURL(url string) error` | ||||||
|  |     *   **说明**: 设置交换的 URL。 | ||||||
|  | *   `GetSymbols() ([]string, error)` | ||||||
|  |     *   **方法签名**: `func GetSymbols() ([]string, error)` | ||||||
|  |     *   **说明**: 获取交易对的符号列表。 | ||||||
|  | *   `GetTicker(symbol string) (*Ticker, error)` | ||||||
|  |     *   **方法签名**: `func GetTicker(symbol string) (*Ticker, error)` | ||||||
|  |     *   **说明**: 获取特定交易对的ticker信息。 | ||||||
|  | 
 | ||||||
|  | ### 接口: Exchange | ||||||
|  | 
 | ||||||
|  | #### 描述 | ||||||
|  | Exchange 是 CCXT Go 的一个接口,用于定义交换的行为。 | ||||||
|  | 
 | ||||||
|  | #### 方法 | ||||||
|  | 
 | ||||||
|  | *   `GetSymbols() ([]string, error)` | ||||||
|  |     *   **方法签名**: `func GetSymbols() ([]string, error)` | ||||||
|  |     *   **说明**: 获取交易对的符号列表。 | ||||||
|  | *   `GetTicker(symbol string) (*Ticker, error)` | ||||||
|  |     *   **方法签名**: `func GetTicker(symbol string) (*Ticker, error)` | ||||||
|  |     *   **说明**: 获取特定交易对的ticker信息。 | ||||||
|  | 
 | ||||||
|  | ### 方法: GetSymbols | ||||||
|  | 
 | ||||||
|  | #### 描述 | ||||||
|  | 获取交易对的符号列表。 | ||||||
|  | 
 | ||||||
|  | #### 方法签名 | ||||||
|  | ```go | ||||||
|  | func (e Exchange) GetSymbols() ([]string, error) | ||||||
|  | ``` | ||||||
|  | #### 例子代码 | ||||||
|  | ```go | ||||||
|  | package main | ||||||
|  | 
 | ||||||
|  | import ( | ||||||
|  |     "fmt" | ||||||
|  |     "github.com/coingecko/coingecko-api/v1/exchange" | ||||||
|  | ) | ||||||
|  | 
 | ||||||
|  | func main() { | ||||||
|  |     // 创建一个新的Exchange实例 | ||||||
|  |     e := exchange.NewExchange() | ||||||
|  | 
 | ||||||
|  |     // 获取交易对的符号列表 | ||||||
|  |     symbols, err := e.GetSymbols() | ||||||
|  |     if err != nil { | ||||||
|  |         fmt.Println(err) | ||||||
|  |         return | ||||||
|  |     } | ||||||
|  | 
 | ||||||
|  |     for _, symbol := range symbols { | ||||||
|  |         fmt.Printf("%s\n", symbol) | ||||||
|  |     } | ||||||
|  | } | ||||||
|  | ``` | ||||||
|  | ### 方法: GetTicker | ||||||
|  | 
 | ||||||
|  | #### 描述 | ||||||
|  | 获取特定交易对的ticker信息。 | ||||||
|  | 
 | ||||||
|  | #### 方法签名 | ||||||
|  | ```go | ||||||
|  | func (e Exchange) GetTicker(symbol string) (*exchange.Ticker, error) | ||||||
|  | ``` | ||||||
|  | #### 例子代码 | ||||||
|  | ```go | ||||||
|  | package main | ||||||
|  | 
 | ||||||
|  | import ( | ||||||
|  |     "fmt" | ||||||
|  |     "github.com/coingecko/coingecko-api/v1/exchange" | ||||||
|  | ) | ||||||
|  | 
 | ||||||
|  | func main() { | ||||||
|  |     // 创建一个新的Exchange实例 | ||||||
|  |     e := exchange.NewExchange() | ||||||
|  | 
 | ||||||
|  |     // 获取特定交易对的ticker信息 | ||||||
|  |     ticker, err := e.GetTicker("BTCUSDT") | ||||||
|  |     if err != nil { | ||||||
|  |         fmt.Println(err) | ||||||
|  |         return | ||||||
|  |     } | ||||||
|  | 
 | ||||||
|  |     fmt.Printf("%+v\n", ticker) | ||||||
|  | } | ||||||
|  | ``` | ||||||
|  | ### 方法: SetURL | ||||||
|  | 
 | ||||||
|  | #### 描述 | ||||||
|  | 设置交换的 URL。 | ||||||
|  | 
 | ||||||
|  | #### 方法签名 | ||||||
|  | ```go | ||||||
|  | func (e Exchange) SetURL(url string) error | ||||||
|  | ``` | ||||||
|  | #### 例子代码 | ||||||
|  | ```go | ||||||
|  | package main | ||||||
|  | 
 | ||||||
|  | import ( | ||||||
|  |     "fmt" | ||||||
|  |     "github.com/coingecko/coingecko-api/v1/exchange" | ||||||
|  | ) | ||||||
|  | 
 | ||||||
|  | func main() { | ||||||
|  |     // 创建一个新的Exchange实例 | ||||||
|  |     e := exchange.NewExchange() | ||||||
|  | 
 | ||||||
|  |     // 设置交换的 URL | ||||||
|  |     err := e.SetURL("https://api.okx.com/api/v5/exchange") | ||||||
|  |     if err != nil { | ||||||
|  |         fmt.Println(err) | ||||||
|  |         return | ||||||
|  |     } | ||||||
|  | 
 | ||||||
|  |     fmt.Printf("URL set successfully\n") | ||||||
|  | } | ||||||
|  | ``` | ||||||
|  | ### 方法: NewExchange | ||||||
|  | 
 | ||||||
|  | #### 描述 | ||||||
|  | 创建新的 Exchange 实例。 | ||||||
|  | 
 | ||||||
|  | #### 方法签名 | ||||||
|  | ```go | ||||||
|  | func NewExchange() (Exchange, error) | ||||||
|  | ``` | ||||||
|  | #### 例子代码 | ||||||
|  | ```go | ||||||
|  | package main | ||||||
|  | 
 | ||||||
|  | import ( | ||||||
|  |     "fmt" | ||||||
|  |     "github.com/coingecko/coingecko-api/v1/exchange" | ||||||
|  | ) | ||||||
|  | 
 | ||||||
|  | func main() { | ||||||
|  |     // 创建一个新的Exchange实例 | ||||||
|  |     e := exchange.NewExchange() | ||||||
|  | 
 | ||||||
|  |     fmt.Printf("Exchange instance created successfully\n") | ||||||
|  | } | ||||||
|  | ``` | ||||||
|  | ### 方法: Ticker | ||||||
|  | 
 | ||||||
|  | #### 描述 | ||||||
|  | 获取特定交易对的ticker信息。 | ||||||
|  | 
 | ||||||
|  | #### 方法签名 | ||||||
|  | ```go | ||||||
|  | type Ticker struct { | ||||||
|  |     // ... | ||||||
|  | } | ||||||
|  | 
 | ||||||
|  | func (e Exchange) GetTicker(symbol string) (*Ticker, error) | ||||||
|  | ``` | ||||||
|  | #### 例子代码 | ||||||
|  | ```go | ||||||
|  | package main | ||||||
|  | 
 | ||||||
|  | import ( | ||||||
|  |     "fmt" | ||||||
|  |     "github.com/coingecko/coingecko-api/v1/exchange" | ||||||
|  | ) | ||||||
|  | 
 | ||||||
|  | func main() { | ||||||
|  |     // 创建一个新的Exchange实例 | ||||||
|  |     e := exchange.NewExchange() | ||||||
|  | 
 | ||||||
|  |     // 获取特定交易对的ticker信息 | ||||||
|  |     ticker, err := e.GetTicker("BTCUSDT") | ||||||
|  |     if err != nil { | ||||||
|  |         fmt.Println(err) | ||||||
|  |         return | ||||||
|  |     } | ||||||
|  | 
 | ||||||
|  |     fmt.Printf("%+v\n", ticker) | ||||||
|  | } | ||||||
|  | ``` | ||||||
|  | ### 方法: Symbol | ||||||
|  | 
 | ||||||
|  | #### 描述 | ||||||
|  | 获取交易对的符号。 | ||||||
|  | 
 | ||||||
|  | #### 方法签名 | ||||||
|  | ```go | ||||||
|  | func (e Exchange) GetSymbols() ([]string, error) | ||||||
|  | ``` | ||||||
|  | #### 例子代码 | ||||||
|  | ```go | ||||||
|  | package main | ||||||
|  | 
 | ||||||
|  | import ( | ||||||
|  |     "fmt" | ||||||
|  |     "github.com/coingecko/coingecko-api/v1/exchange" | ||||||
|  | ) | ||||||
|  | 
 | ||||||
|  | func main() { | ||||||
|  |     // 创建一个新的Exchange实例 | ||||||
|  |     e := exchange.NewExchange() | ||||||
|  | 
 | ||||||
|  |     // 获取交易对的符号列表 | ||||||
|  |     symbols, err := e.GetSymbols() | ||||||
|  |     if err != nil { | ||||||
|  |         fmt.Println(err) | ||||||
|  |         return | ||||||
|  |     } | ||||||
|  | 
 | ||||||
|  |     for _, symbol := range symbols { | ||||||
|  |         fmt.Printf("%s\n", symbol) | ||||||
|  |     } | ||||||
|  | } | ||||||
|  | ``` | ||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user