Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.95 KB

RangedMarketApi.md

File metadata and controls

79 lines (55 loc) · 2.95 KB
Raw

kalshi.RangedMarketApi

All URIs are relative to https://trading-api.kalshi.com/v1

Method HTTP request Description
get_ranged_market GET /ranged_markets/{ranged_market_id} GetRangedMarket

get_ranged_market

GetRangedMarketResponse get_ranged_market(ranged_market_id)

GetRangedMarket

End-point for getting data about a ranged market

Example

import time
import kalshi
from kalshi.api import ranged_market_api
from kalshi.model.get_ranged_market_response import GetRangedMarketResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = ranged_market_api.RangedMarketApi(api_client)
    ranged_market_id = "ranged_market_id_example" # str | Should be filled in with a ranged market id

    # example passing only required values which don't have defaults set
    try:
        # GetRangedMarket
        api_response = api_instance.get_ranged_market(ranged_market_id)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling RangedMarketApi->get_ranged_market: %s\n" % e)

Parameters

Name Type Description Notes
ranged_market_id str Should be filled in with a ranged market id

Return type

GetRangedMarketResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 GetRangedMarketResponse -
400 JSONError is a generic structure for API error responses. * code -
* details -
* message -
* service -
401 JSONError is a generic structure for API error responses. * code -
* details -
* message -
* service -
403 JSONError is a generic structure for API error responses. * code -
* details -
* message -
* service -
404 JSONError is a generic structure for API error responses. * code -
* details -
* message -
* service -
500 JSONError is a generic structure for API error responses. * code -
* details -
* message -
* service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]