location#

Autogenerated API

argus_api.lib.geoip.v1.location.add_location(id: int = None, extID: int = None, countryCode: str = None, locationName: str = None, lastUpdatedTimestamp: int = None, flags: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Add new location (DEV)

Parameters

  • id (int) –

  • extID (int) – The external ID of the location (0 if not set).

  • countryCode (str) – The two-letter code of the country where this location is in.

  • locationName (str) – The name of the the location.

  • lastUpdatedTimestamp (int) – The timestamp when this location was last updated.

  • flags (list) – Flags assigned to the object.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.geoip.v1.location.get_location(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Lookup location (INTERNAL)

Parameters

  • id (int) – Location ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.geoip.v1.location.list_locations(sortBy: str = None, limit: int = 25, offset: int = None, fromID: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List locations (INTERNAL)

Parameters

  • sortBy (list) – Fields to sort results by (without a sign is ascending, with ‘-’ sign is descending, supported fields are: id, externalID, countryCode, regionCode)

  • limit (int) – Max number of items to return

  • offset (int) – The amount of items to skip from the beginning

  • fromID (int) – Only return locations with numeric ID greater than or equal to this value

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.geoip.v1.location.search_locations(country: str = None, extID: int = None, fromID: int = None, includeFlags: str = None, excludeFlags: str = None, includeDeleted: bool = None, startTimestamp: int = None, endTimestamp: int = None, limit: int = None, offset: int = None, sortBy: str = None, countTimeout: int = - 1, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Find locations (INTERNAL)

Parameters

  • country (list) – Only return locations from these countries (by country ID or two-letter code).

  • extID (list) – Only return locations bound to these external IDs.

  • fromID (int) – Only return locations with IDs greater than or equal to this ID.

  • includeFlags (list) – A set of included enumerated flags of the searched locations.

  • excludeFlags (list) – A set of excluded enumerated flags of the searched locations.

  • includeDeleted (bool) – If true, also include locations marked as deleted.

  • startTimestamp (int) – Search for locations having lastUpdatedTimestamp greater than or equal to this timestamp.

  • endTimestamp (int) – Search for locations having lastUpdatedTimestamp lower than or equal to this timestamp.

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • sortBy (list) – Fields to sort results by (without a sign is ascending, with ‘-’ sign is descending).

  • countTimeout (int) – Max wait in seconds for the count query to run. Set the value to -1 to skip counting (count will be returned -1). Set the value to 0 to execute the count query as long as the service allows, max allowed timeout value is 30 (seconds), default value is -1. (default -1)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON